stMemoryInit function

stMemoryInit Function

Declaration:

BOOL stMemoryInit(
  PVOID MemoryPool,
  SIZE MemorySize
);

Parameters:

MemoryPool

Address of the memory pool to be initialized.

MemorySize

Size of the memory.

Return value:

TRUE on success or FALSE on failure. Use the stGetLastError function to obtain extended error information.

Description:

This function initializes a memory pool at the specified memory address. The memory address must subsequently be passed to the stMemoryAlloc and stMemoryFree functions to allocate and release memory blocks within this pool.

The memory pool can be enlarged by defining additional areas using the stMemoryExpand function. Please refer to its description for more information.

This function will not be compiled if memory management functions are disabled by setting ST_USE_MEMORY to 0.

Version:	1.0
Header file:	ST_Memory.h (include ST_API.h)
See also:	BOOL, dynamic memory allocation example, FALSE, memory management, memory pool initialization example, PVOID, SIZE, ST_USE_MEMORY, stGetLastError, stMemoryAlloc, stMemoryExpand, stMemoryFree, TRUE

SpaceShadow documentation