FLAIM: Pool Memory Functions

- Main Page
- Modules
- Classes
- Files

# Pool Memory Functions
[Miscellaneous Functions]

## Functions
FINLINE void FLMAPI | F_Pool::poolInit (FLMUINT uiBlockSize)
| Initialize memory pool.
RCODE FLMAPI | F_Pool::poolAlloc (FLMUINT uiSize, void **ppvPtr)
| Allocate memory from a memory pool.
RCODE FLMAPI | F_Pool::poolCalloc (FLMUINT uiSize, void **ppvPtr)
| Allocate memory from a memory pool and initialize memory to zeroes. Pointer to the allocation.
void FLMAPI | F_Pool::poolFree (void)
| Free all memory blocks in a memory pool.
void FLMAPI | F_Pool::poolReset (void *pvMark=NULL, FLMBOOL bReduceFirstBlock=FALSE)
| Reset a memory pool back to a mark. Free all memory blocks allocated after the mark.
FINLINE void *FLMAPI | F_Pool::poolMark (void)
| Obtain a mark in a memory pool. Returned mark remembers a location in the pool which can later be passed to poolReset() to free all memory that was allocated after the mark.

## Function Documentation

RCODE FLMAPI F_Pool::poolAlloc | ( | FLMUINT | uiSize,
|  | void ** | ppvPtr
| ) | `[inherited]`

  | Allocate memory from a memory pool. Parameters:
  uiSize | Requested allocation size (in bytes).
  ppvPtr | Pointer to the allocation

RCODE FLMAPI F_Pool::poolCalloc | ( | FLMUINT | uiSize,
|  | void ** | ppvPtr
| ) | `[inherited]`

  | Allocate memory from a memory pool and initialize memory to zeroes. Pointer to the allocation. Parameters:
  uiSize | Requested allocation size (in bytes).

FINLINE void FLMAPI F_Pool::poolInit | ( | FLMUINT | uiBlockSize | ) | `[inline, inherited]`

  | Initialize memory pool. Parameters:
  uiBlockSize | Default block size for the memory pool.

void FLMAPI F_Pool::poolReset | ( | void * | pvMark = `NULL`,
|  | FLMBOOL | bReduceFirstBlock = `FALSE`
| ) | `[inherited]`

  | Reset a memory pool back to a mark. Free all memory blocks allocated after the mark. Parameters:
  pvMark | Mark that was obtained from GedPoolMark().