Export (0) Print
Expand All

Heap32First function

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

Syntax


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

Parameters

lphe [in, out]

A pointer to a HEAPENTRY32 structure.

th32ProcessID [in]

The identifier of the process context that owns the heap.

th32HeapID [in]

The identifier of the heap to be enumerated.

Return value

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.

Examples

For an example, see Traversing the Heap List.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

TlHelp32.h

Library

Kernel32.lib

DLL

Kernel32.dll

See also

Heap Lists and Heap Walking
Heap32Next
HEAPENTRY32
Tool Help Functions

 

 

Community Additions

ADD
Show:
© 2014 Microsoft