Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 3.61 KB

aligned-offset-recalloc.md

File metadata and controls

72 lines (51 loc) · 3.61 KB
description title ms.date api_name api_location api_type topic_type f1_keywords helpviewer_keywords ms.assetid
Learn more about: _aligned_offset_recalloc
_aligned_offset_recalloc
4/2/2020
_aligned_offset_recalloc
_o__aligned_offset_recalloc
msvcrt.dll
msvcr80.dll
msvcr90.dll
msvcr100.dll
msvcr100_clr0400.dll
msvcr110.dll
msvcr110_clr0400.dll
msvcr120.dll
msvcr120_clr0400.dll
ucrtbase.dll
api-ms-win-crt-heap-l1-1-0.dll
DLLExport
apiref
aligned_offset_recalloc
_aligned_offset_recalloc
aligned_offset_recalloc function
_aligned_offset_recalloc function
a258f54e-eeb4-4853-96fc-007d710f98e9

_aligned_offset_recalloc

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_offset_recalloc(
   void *memblock,
   size_t num,
   size_t size,
   size_t alignment,
   size_t offset
);

Parameters

memblock
The current memory block pointer.

number
Number of elements.

size
Length in bytes of each element.

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

offset
The offset into the memory allocation to force the alignment.

Return value

_aligned_offset_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.

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

Remarks

Like _aligned_offset_malloc, _aligned_offset_recalloc allows a structure to be aligned at an offset within the structure.

_aligned_offset_recalloc is based on malloc. For more information about using _aligned_offset_malloc, see malloc. If memblock is NULL, the function calls _aligned_offset_malloc internally.

This function sets errno to ENOMEM if the memory allocation failed or if the requested size (number * size) was greater than _HEAP_MAXREQ. For more information about errno, see errno, _doserrno, _sys_errlist, and _sys_nerr. Also, _aligned_offset_recalloc validates its parameters. If alignment isn't a power of 2, or if offset is non-zero and greater than or equal to the requested size, 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_offset_recalloc <malloc.h>

See also

Data alignment
_recalloc
_aligned_recalloc