GetProcessHeap

A version of this page is also available for

Windows Embedded CE 6.0 R3

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 HeapSize functions.

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 GetProcessHeap function allows you to allocate memory from the process heap without having to first create a heap with the HeapCreate function, 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 HeapDestroy function.

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

Reference

Memory Management Functions
HeapAlloc
HeapCreate
HeapDestroy
HeapFree
HeapReAlloc
HeapSize