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 block of a heap allocated by a process.

Syntax 

BOOL WINAPI Heap32First(
  HANDLE 
hSnapshot,
  LPHEAPENTRY32
 lphe,
  DWORD
 th32ProcessID,
  DWORD
 th32HeapID
);

Parameters

hSnapshot

[in] Handle to the snapshot returned from a previous call to the CreateToolhelp32Snapshotfunction. This parameter is specific to Windows Embedded CE.

lphe

[out] Pointer to a HEAPENTRY32structure.

th32ProcessID

[in] Identifier of the process context that owns the heap.

th32HeapID

[in] Identifier of the heap to enumerate.

Return Value

TRUE indicates that information for the first heap block has been copied to the buffer. FALSE indicates success. The ERROR_NO_MORE_FILES error value, returned by GetLastError, indicates that the heap is invalid or empty.

Remarks

The calling application must set the dwSizemember of HEAPENTRY32to the size, in bytes, of the structure.

Heap32Firstchanges 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 access subsequent blocks of the same heap, use the Heap32Nextfunction.

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