Mem_PoolClr()

Clears a memory pool by setting all memory pool controls to their uninitialized values.

This function is deprecated and will be removed in a future version of this product.

Files

lib_mem.h/lib_mem.c

Prototype

          void  Mem_PoolClr (MEM_POOL  *pmem_pool,
                             LIB_ERR   *perr);

Arguments

pmem_pool

Pointer to a memory pool structure to clear.

perr

Pointer to variable that will receive the return error code from this function:

LIB_MEM_ERR_NONE LIB_MEM_ERR_NULL_PTR

Returned Value

None.

Required Configuration

Available only if LIB_MEM_CFG_HEAP_SIZE is > 0 in lib_cfg.h.

Notes / Warnings

pmem_pool must be passed a valid pointer to the address of a declared MEM_POOL variable.

Example Usage

          MEM_POOL  AppMemPool;
          LIB_ERR   err;
           
          Mem_PoolClr(&AppMemPool, &err);  /* Clear memory pool. */
           
          if (err != LIB_ERR_NONE) {
              printf("COULD NOT CLEAR MEMORY POOL.");
          }