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 obtains a handle to the heap of the calling process. This handle can then be used in calls to the HeapAlloc, HeapReAlloc, HeapFree, and HeapSizefunctions.

Syntax

HANDLE GetProcessHeap(VOID);

Parameters

None.

Return Value

A handle to the heap of the calling process indicates success. NULL indicates failure. To get extended error information, call GetLastError.

Remarks

The GetProcessHeapfunction allows you to allocate memory from the process heap without having to first create a heap with the HeapCreatefunction, as shown in this example.

Copy Code
HeapAlloc(GetProcessHeap(), 0, dwBytes);
Note:
The handle obtained by calling this function should not be used in calls to the HeapDestroyfunction.

Requirements

Header winbase.h
Library Lmem.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also