Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

Gets a memory pool’s remaining number of blocks available to allocate.

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

Files

lib_mem.h/lib_mem.c

Prototype

Arguments

pmem_pool

Pointer to a memory pool structure.

perr

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

LIB_MEM_ERR_NONE
LIB_MEM_ERR_NULL_PTR
LIB_MEM_ERR_INVALID_POOL

Returned Value

Remaining memory pool blocks, if no errors;

0, otherwise.

Required Configuration

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

Notes / Warnings

Mem_PoolBlkGetNbrAvail() ONLY supports non-heap memory pools. Mem_HeapGetSizeRem()/Mem_SegGetSizeRem() should be used for heap memory pool/segment (see section 4-4-3 and section 4-4-4).

Example Usage

  • No labels