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

Restores a pool to its creation state.

BOOLEAN mpool_reset(
    MPOOL pool
);

Parameters

pool
The memory pool created by mpool_create.

Remarks

If pool is a dynamic pool then all pages return to the OS and are invalid. Any pointers referencing memory within the pool become invalid, statistics for the pool also reset.

Return Values

TRUE
Success.
FALSE
Failure. The function sets errno to this value:
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