NAME
realloc — memory
reallocator
SYNOPSIS
#include
<stdlib.h>
void *realloc(void *ptr, size_t size);
DESCRIPTION
[CX] The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of IEEE Std 1003.1-2001 (“POSIX.1”) defers to the ISO C standard.
The realloc () function shall change the
size of the memory object pointed to by ptr to the size
specified by size. The contents of the object shall remain
unchanged up to the lesser of the new and old sizes. If the new size of the
memory object would require movement of the object, the space for the
previous instantiation of the object is freed. If the new size is larger,
the contents of the newly allocated portion of the object are unspecified.
If size is 0 and ptr is not a null
pointer, the object pointed to is freed. If the space cannot be allocated,
the object shall remain unchanged.
If ptr is a null pointer,
realloc () shall be equivalent to
malloc(3) for the specified size.
If ptr does not match a pointer returned earlier
by calloc(3), malloc(3), or
realloc () or if the space has previously been
deallocated by a call to free(3) or
realloc (), the behavior is undefined.
The order and contiguity of storage allocated by successive calls
to realloc () is unspecified. The pointer returned
if the allocation succeeds shall be suitably aligned so that it may be
assigned to a pointer to any type of object and then used to access such an
object in the space allocated (until the space is explicitly freed or
reallocated). Each such allocation shall yield a pointer to an object
disjoint from any other object. The pointer returned shall point to the
start (lowest byte address) of the allocated space. If the space cannot be
allocated, a null pointer shall be returned.
RETURN VALUE
Upon successful completion with a size not equal to 0,
realloc () shall return a pointer to the (possibly
moved) allocated space. If size is 0, either a null
pointer or a unique pointer that can be successfully passed to
free(3) shall be returned. If there is not enough
available memory, realloc () shall return a null
pointer [CX] and set errno to
[ENOMEM].
ERRORS
The realloc () function shall fail if:
- [ENOMEM]
- [CX] Insufficient memory is available.
EXAMPLES
None.
APPLICATION USAGE
None.
RATIONALE
None.
FUTURE DIRECTIONS
None.
SEE ALSO
calloc(3), free(3), malloc(3), the Base Definitions volume of IEEE Std 1003.1-2001 (“POSIX.1”), <stdlib.h>
CHANGE HISTORY
First released in Issue 1. Derived from Issue 1 of the SVID.
Issue 6
Extensions beyond the ISO C standard are marked.
The following new requirements on POSIX implementations derive from alignment with the Single UNIX Specification:
- In the RETURN VALUE section, if there is not enough available memory, the setting of errno to [ENOMEM] is added.
- The [ENOMEM] error condition is added.
End of informative text. footer end