Clears a memory pool by setting all memory pool controls to their uninitialized values.
| Warning |
|---|
This function is deprecated and will be removed in a future version of this product. |
Files
lib_mem.h/lib_mem.c
Prototype
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
void Mem_PoolClr (MEM_POOL *pmem_pool,
LIB_ERR *perr);
|
Arguments
pmem_pool
Pointer to a memory pool structure to clear.
...
pmem_pool must be passed a valid pointer to the address of a declared MEM_POOL variable.
Example Usage
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
MEM_POOL AppMemPool;
LIB_ERR err;
Mem_PoolClr(&AppMemPool, &err); /* Clear memory pool. */
if (err != LIB_ERR_NONE) {
printf("COULD NOT CLEAR MEMORY POOL.");
}
|