Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages

kStatus kPoolAlloc_Clear | ( | kPoolAlloc | object | ) |

Returns surplus memory to the underlying allocator.

For block-based ranks, any unused blocks will be returned to the underlying allocator. Reservations made using kPoolAlloc_Reserve/kPoolAlloc_ReserveAt are honored; those blocks will be preserved for later use.

For ranks configured to cache buffers upon deallocation, any unused buffers will be returned to the underlying allocator. Reservations made using kPoolAlloc_ReserveAt are honored; those buffers will be preserved for later use.

Parameters

  object | kPoolAlloc object.

Returns
  Operation status.