`_aligned_recalloc`

Article
12/02/2022

Changes the size of a memory block that was allocated with _aligned_malloc or _aligned_offset_malloc and initializes the memory to 0.

Syntax

void * _aligned_recalloc(
   void *memblock,
   size_t num,
   size_t size,
   size_t alignment
);

Parameters

memblock
The current memory block pointer.

number
The number of elements.

size
The size in bytes of each element.

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

Return value

_aligned_recalloc returns a void pointer to the reallocated (and possibly moved) memory block. The return value is NULL if the size is zero and the buffer argument isn't NULL, or if there isn't enough available memory to expand the block to the given size. In the first case, the original block is freed. In the second case, the original block is unchanged. The return value points to a storage space that is suitably aligned for storage of any type of object. To get a pointer to a type other than void, use a type cast on the return value.

It's an error to reallocate memory and change the alignment of a block.

Remarks

_aligned_recalloc is based on malloc. For more information about using _aligned_offset_malloc, see malloc.

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_recalloc validates its parameters. If alignment isn't a power of 2, 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.

By default, this function's global state is scoped to the application. To change this behavior, see Global state in the CRT.

Requirements

Routine	Required header
`_aligned_recalloc`	<malloc.h>