stFixedMemInit function

stFixedMemInit Function

Declaration:

BOOL stFixedMemInit(
  PVOID MemoryPool,
  SIZE MemorySize,
  SIZE BlockSize
);

Parameters:

MemoryPool

Address of the memory pool to be initialized.

MemorySize

Total size of the memory pool.

BlockSize

Size of each memory block to be allocated.

Return value:

TRUE on success or FALSE on failure.

Description:

This function initializes a memory pool at the specified memory address. This address must subsequently be passed to the stFixedMemAlloc and stFixedMemFree functions to allocate and release memory blocks within this pool. The size of every allocated block is fixed. This function does not set the last error code upon failure. Access to fixed-size memory is not internally synchronized; if thread safety is required, it must be implemented externally.

This function will not be compiled if fixed-size memory management functions are disabled by setting ST_USE_FIXMEM to 0.

Version:	1.0
Header file:	ST_FixMem.h (include ST_API.h)
See also:	BOOL, FALSE, fixed size memory pool initialization example, memory allocation example, PVOID, SIZE, ST_USE_FIXMEM, stFixedMemAlloc, stFixedMemFree, TRUE

SpaceShadow documentation