GetProcessHeap

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.

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.

HANDLE GetProcessHeap(VOID)

Parameters

None.

Return Values

A handle to the calling process's heap 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:

HeapAlloc(GetProcessHeap(), 0, dwBytes);

Note The handle obtained by calling this function should not be used in calls to the HeapDestroyfunction.

Requirements

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	1.0 and later	Winbase.h		Lmem.lib

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.