_aligned_offset_malloc

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at _aligned_offset_malloc.

Allocates memory on a specified alignment boundary.

Syntax

void * _aligned_offset_malloc(  
   size_t size,   
   size_t alignment,   
   size_t offset  
);  

Parameters

[in] size
The size of the requested memory allocation.

[in] alignment
The alignment value, which must be an integer power of 2.

[in] offset
The offset into the memory allocation to force the alignment.

Return Value

A pointer to the memory block that was allocated or NULL if the operation failed.

Remarks

_aligned_offset_malloc is useful in situations where alignment is needed on a nested element; for example, if alignment was needed on a nested class.

_aligned_offset_malloc is based on malloc; for more information, see malloc.

_aligned_offset_malloc is marked __declspec(noalias) and __declspec(restrict), meaning that the function is guaranteed not to modify global variables and that the pointer returned is not aliased. For more information, see noalias and restrict.

This function sets errno to ENOMEM if the memory allocation failed or if the requested size was greater than _HEAP_MAXREQ. For more information about errno, see errno, _doserrno, _sys_errlist, and _sys_nerr. Also, _aligned_offset_malloc validates its parameters. If alignment is not a power of 2 or if offset is greater than or equal to size and nonzero, this function invokes the invalid parameter handler, as described in Parameter Validation. If execution is allowed to continue, this function returns NULL and sets errno to EINVAL.

Requirements

Example

For more information, see _aligned_malloc.

See Also

Data Alignment