Gets a memory pool’s remaining segment size 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.
align
Desired word boundary alignment (in octets) to return remaining memory size from.
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
LIB_MEM_ERR_INVALID_MEM_ALIGN
Returned Value
Remaining memory segment size (in octets), if no errors;
0, otherwise.
Required Configuration
Available only if LIB_MEM_CFG_HEAP_SIZE is > 0 in lib_cfg.h.
Notes / Warnings
Remaining size of memory segments returned from either memory segment’s configured dedicated memory, if any, or heap memory pool, otherwise.