Heap32ListFirst

Windows Mobile 6.5
A version of this page is also available for
4/8/2010

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


BOOL WINAPI Heap32ListFirst(
  HANDLE hSnapshot,
  LPHEAPLIST32 lphl
);

hSnapshot

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

lphl

[out] Pointer to a HEAPLIST32 structure.

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.

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 number is never greater than the initial value of dwSize, but it can be smaller. If the value is smaller, do not rely on the values of members whose offsets are greater than this value. To retrieve information about other heaps in the heap list, use the Heap32ListNext function.

HeaderTlhelp.h
Librarytoolhelp.lib
Windows Embedded CEWindows CE 2.0 and later
Windows MobileWindows Mobile Version 5.0 and later

Community Additions

Show: