stMemoryGetInfo function

stMemoryGetInfo Function

Declaration:

void stMemoryGetInfo(
  PVOID MemoryPool,
  ULONG *TotalMemory,
  ULONG *FreeMemory
);

Parameters:

MemoryPool

Address of the memory pool.

TotalMemory

A pointer to a variable that receives the total memory size in bytes (may be set to NULL if this value is not required).

FreeMemory

A pointer to a variable that receives the free memory size in bytes (may be set to NULL if this value is not required).

Description:

This function retrieves information regarding memory capacities. The sizes are specified using the ULONG type (rather than SIZE) because the memory pool descriptor can encompass multiple memory regions, and their combined size may exceed the capacity of a SIZE type variable.

If this function is not required, it can be excluded from compilation by setting ST_GET_MEMORY_INFO_FUNC to 0. Additionally, the 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:	memory management, NULL, PVOID, SIZE, ST_GET_MEMORY_INFO_FUNC, ST_USE_MEMORY, ULONG

SpaceShadow documentation