Heap32First

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

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

Parameters

lphe

[in/out] Pointer to a HEAPENTRY32 structure.

th32ProcessID

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

th32HeapID

[in] Identifier of the heap to enumerate.

Return Values

Returns TRUE if information for the first heap block has been copied to the buffer or FALSE otherwise. The ERROR_NO_MORE_FILES error value is returned by the GetLastError function if the heap is invalid or empty.

Remarks

The calling application must set the dwSize member of HEAPENTRY32 to the size, in bytes, of the structure. Heap32First 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 access subsequent blocks of the same heap, use the Heap32Next 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, , Heap32Next, HEAPENTRY32