Heap32ListFirst

Retrieves information about the first heap that has been allocated by a specified process.

BOOL WINAPI Heap32ListFirst(
  HANDLE hSnapshot,  
  LPHEAPLIST32 lphl  
);

Parameters

hSnapshot

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

lphl

[in/out] Pointer to a HEAPLIST32 structure.

Return Values

Returns TRUE if the first entry of the heap list has been copied to the buffer or FALSE otherwise. The ERROR_NO_MORE_FILES error value is returned by the GetLastError function when 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.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Tlhelp32.h.
  Library: Use Kernel32.lib.

See Also

Tool Help Library Overview, Tool Help Functions, , CreateToolhelp32Snapshot, HEAPLIST32, Heap32ListNext