INtime SDK Help
mpool_compact
INtime SDK v6 > About INtime > Other system libraries > Heaps and memory pools > Memory pools > mpool_compact

Returns to the OS memory-freed pages and no longer in use via mpool_free.

BOOLEAN mpool_compact(
    MPOOL pool
);

Parameters

pool
The memory pool created by mpool_create.

Remarks

As memory pages return to the OS, the total physical and virtual memory burden for the process reduces, which you can observe with INtex (an INtime utility).

This call has an effect on only dynamic pools.

Return Values

TRUE
Success.
FALSE
Failure. The function sets errno to one of these values:
EEXIST The pool is deleted.
EINVAL The pool is not a valid MPOOL.

Requirements

Versions Defined in Include Link to
INtime 4.0 intime/rt/include/mpool.h mpool.h clib.lib
   
See Also

Utilities