Heap32ListFirst

This function retrieves information about the first heap that has been allocated by a specified process.

At a Glance

Syntax

BOOL WINAPI Heap32ListFirst( HANDLE hSnapshot,
LPHEAPLIST32 lphl);

Parameters

hSnapshot

Handle to the snapshot returned from a previous call to the CreateToolhelp32Snapshot function.

lphl

Pointer to a HEAPLIST32 structure.

Return Value

TRUE indicates that the first entry of the heap list has been copied to the buffer. FALSE indicates failure. The ERROR_NO_MORE_FILES error value, returned by GetLastError, indicates that no heap list exists or the snapshot does not contain heap list information.

Remarks

The calling application must set the dwSize member of HEAPLIST32 to the size, in bytes, of the structure. Heap32ListFirst changes dwSize to the number of bytes written to the structure. This will never be greater than the initial value of dwSize, but it may be smaller. If the value is smaller, do not rely on the values of any members whose offsets are greater than this value.

To retrieve information about other heaps in the heap list, use the Heap32ListNext function.