 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 allocates a block of task memory.
LPVOID CoTaskMemAlloc( ULONG cb );
Parameters
- cb
- [in] Size, in bytes, of the memory block to be allocated.
Return Values
A pointer to the allocated memory block indicates success. NULL indicates insufficient memory.
Remarks
The initial contents of the returned memory block are undefined – there is no guarantee that the block has been initialized. The allocated block may be larger than cbbytes because of the space required for alignment and for maintenance information.
If cbis zero, CoTaskMemAllocallocates a zero-length item and returns a valid pointer to that item. If there is insufficient memory available, CoTaskMemAllocreturns NULL.
Applications should always check the return value from this method, even when requesting small amounts of memory, because there is no guarantee the memory will be allocated.
Passing into this function any invalid and, under some circumstances, NULL pointers result in unexpected termination of the application.
Requirements
Runs On Versions Defined in Include Link to Windows CE OS 2.0 and later 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.