ForEachFreePoolMember

Initializes free memory-pool entries.

Synopsis

Boolean ForEachFreePoolMember (MemPoolPtr memPool, 
ForEachFreePoolMemberFuncPtr forEachFunc, void* argValue)

Description

Performs an initialization function on each free entry in a memory pool. FillPoolWithMsgItems() calls ForEachFreePoolMember() to assign a message item to each entry in a memory pool.

The function may be any function, but forEachFunc is normally defined as an initialization function. The function is called with a pointer to the data field of the entry.

Arguments

memPool: Memory pool upon whose entries the function is performed.

forEachFunc: Function performed on each entry.

argValue: Argument string passed to the function.

Return Value

Value: Error Condition

TRUE: Initialization function returns TRUE for each entry

FALSE: Initialization function returns FALSE for any entry

Associated Files