Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
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.

Syntax 

BOOL WINAPI Heap32ListFirst(
  HANDLE
 hSnapshot,
  LPHEAPLIST32
 lphl
);

Parameters

hSnapshot

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

lphl

[out] Pointer to a HEAPLIST32structure.

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 dwSizemember of HEAPLIST32to the size, in bytes, of the structure. Heap32ListFirstchanges dwSizeto 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 Heap32ListNextfunction.

Requirements

Header Tlhelp.h
Library toolhelp.lib
Windows Embedded CE Windows CE 2.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also