Expand Minimize

GetProcessHeap function

Retrieves a handle to the default heap of the calling process. This handle can then be used in subsequent calls to the heap functions.

Syntax


HANDLE WINAPI GetProcessHeap(void);

Parameters

This function has no parameters.

Return value

If the function succeeds, the return value is a handle to the calling process's heap.

If the function fails, the return value is NULL. To get extended error information, call GetLastError.

Remarks

The GetProcessHeap function obtains a handle to the default heap for the calling process. A process can use this handle to allocate memory from the process heap without having to first create a private heap using the HeapCreate function.

Windows Server 2003 and Windows XP:  To enable the low-fragmentation heap for the default heap of the process, call the HeapSetInformation function with the handle returned by GetProcessHeap.

Windows Phone 8: This API is supported.

Windows Phone 8.1: This API is supported.

Examples

For an example, see Getting Process Heaps.

Requirements

Minimum supported client

Windows XP [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2003 [desktop apps | Windows Store apps]

Header

HeapApi.h (include Windows.h);
WinBase.h on Windows Server 2008 R2, Windows 7, Windows Server 2008, Windows Vista, Windows Server 2003, and Windows XP (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

Heap Functions
HeapCreate
Memory Management Functions

 

 

Community Additions

ADD
Show:
© 2014 Microsoft