 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 creates a heap object that is private to the calling process. This reserves a contiguous block of the process's virtual address space and allocates physical storage for a specified initial portion of this block.
HANDLE HeapCreate( DWORD flOptions , DWORD dwInitialSize, DWORD dwMaximumSize );
Parameters
- flOptions
- [in] Specifies optional attributes for the new heap. These
flags will affect subsequent access to the new heap through calls
to the heap functions (
HeapAlloc,
HeapFree,
HeapReAlloc, and
HeapSize). You can specify the
flag listed in the following table.
Value Description HEAP_NO_SERIALIZE Specifies that mutual exclusion will not be used when the heap functions allocate and free memory from this heap. The default, when the HEAP_NO_SERIALIZE flag is not specified is to serialize access to the heap. Serialization of heap access allows two or more threads to simultaneously allocate and free memory from the same heap. - dwInitialSize
- [in] Specifies the initial size, in bytes, of the heap. This value determines the initial amount of physical storage that is allocated for the heap. The value is rounded up to the next page boundary. To determine the size of a page on the host computer, use the GetSystemInfofunction.
- dwMaximumSize
- Unsupported.
Return Values
A handle to the newly created heap indicates success. NULL indicates failure. To get extended error information, call GetLastError.
Remarks
The HeapCreatefunction creates a private heap object from which the calling process can allocate memory blocks using the HeapAllocfunction. The initial size determines the number of committed pages that are initially allocated for the heap. These pages create a block in the process's virtual address space into which the heap can grow. If requests by HeapAllocexceed the current size of committed pages, additional pages are automatically committed from this reserved space, assuming that the physical storage is available.
The memory of a private heap object is accessible only to the process that created it. If a dynamic-link library (DLL) creates a private heap, the heap is created in the address space of the process that called the DLL and it is accessible only to that process.
The system uses memory from the private heap to store heap support structures, so not all of the specified heap size is available to the process. For example, if the HeapAllocfunction requests 64 KB from a heap with a maximum size of 64 KB, the request may fail because of system overhead.
If the HEAP_NO_SERIALIZE flag is not specified (the simple default), the heap will serialize access within the calling process. Serialization ensures mutual exclusion when two or more threads attempt to simultaneously allocate or free blocks from the same heap. There is a small performance cost to serialization, but it must be used whenever multiple threads allocate and free memory from the same heap.
Setting the HEAP_NO_SERIALIZE flag eliminates mutual exclusion on the heap. Without serialization, two or more threads that use the same heap handle might attempt to allocate or free memory simultaneously, likely causing corruption in the heap. The HEAP_NO_SERIALIZE flag can, therefore, be safely used only in the following situations:
- The process has only one thread.
- The process has multiple threads, but only one thread calls the heap functions for a specific heap.
- The process has multiple threads, and the application provides
its own mechanism for mutual exclusion to a specific heap.
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.
See Also
GetLastError, GetSystemInfo, HeapAlloc, HeapDestroy, HeapFree, HeapReAlloc, HeapSize