.TH LIBSIMPLE_VCALLOCN 3 libsimple
.SH NAME
libsimple_vcallocn \- allocate memory
.SH SYNOPSIS
.nf
#include <libsimple.h>
inline void *libsimple_vcallocn(size_t \fIn\fP, va_list \fIap\fP);
inline void *libsimple_envcallocn(int \fIstatus\fP, size_t \fIn\fP, va_list \fIap\fP);
inline void *libsimple_evcallocn(size_t \fIn\fP, va_list \fIap\fP);
inline void *libsimple_callocn(size_t \fIn\fP, ..., /* (size_t)0 */);
inline void *libsimple_encallocn(int \fIstatus\fP, size_t \fIn\fP, ..., /* (size_t)0 */);
inline void *libsimple_ecallocn(size_t \fIn\fP, ..., /* (size_t)0 */);
#ifndef vcallocn
# define vcallocn libsimple_vcallocn
#endif
#ifndef envcallocn
# define envcallocn libsimple_envcallocn
#endif
#ifndef evcallocn
# define evcallocn libsimple_evcallocn
#endif
#ifndef callocn
# define callocn libsimple_callocn
#endif
#ifndef encallocn
# define encallocn libsimple_encallocn
#endif
#ifndef ecallocn
# define ecallocn libsimple_ecallocn
#endif
.fi
.PP
Link with
.IR \-lsimple .
.SH DESCRIPTION
The
.BR libsimple_callocn (),
.BR libsimple_encallocn (),
and
.BR libsimple_ecallocn ()
functions are wrappers for the
.BR calloc (3)
function, they allocate
.I N
zero-initialised bytes to the heap and return a
pointer with an alignment of
.I alignof(max_align_t)
to the allocated memory, where
.I N
is the product of
.I n
and all following arguments (which should have the type
.BR size_t )
up to the first 0;
.I n
must not be 0. The function
.BR free (3)
shall be called with the returned pointer as
input when the allocated memory is no longer needed.
.PP
The
.BR libsimple_encallocn ()
and
.BR libsimple_ecallocn ()
functions will terminate the process if the memory
cannot be allocated, by calling the
.BR libsimple_enprintf ()
and
.BR libsimple_eprintf ()
functions, respectively.
On failure, the process's exit value will be
.I status
if the
.BR libsimple_encallocn ()
function is used or
.IR libsimple_default_failure_exit (3)
if the
.BR libsimple_ecallocn ()
function is used.
.PP
The
.BR libsimple_vcallocn (),
.BR libsimple_envcallocn (),
and
.BR libsimple_evcallocn ()
functions are versions of the
.BR libsimple_callocn (),
.BR libsimple_encallocn (),
and
.BR libsimple_ecallocn (),
respectively, that use
.B va_list
instead of variadic arguments.
.SH RETURN VALUE
The
.BR libsimple_vcallocn (),
.BR libsimple_envcallocn (),
.BR libsimple_evcallocn (),
.BR libsimple_callocn (),
.BR libsimple_encallocn (),
and
.BR libsimple_ecallocn ()
functions return a pointer to the allocated memory
upon success completion; otherwise the
.BR libsimple_vcallocn ()
and
.BR libsimple_callocn ()
functions return
.B NULL
and set
.I errno
it indicate the error, and the
.BR libsimple_envcallocn (),
.BR libsimple_evcallocn (),
.BR libsimple_encallocn (),
and
.BR libsimple_ecallocn ()
functions terminated the process.
.SH ERRORS
The
.BR libsimple_vcallocn (),
.BR libsimple_callocn ()
function will fail for the reasons specified for the
.BR calloc (3)
function, and if:
.TP
.B EINVAL
.I n
is 0.
.PP
The
.BR libsimple_envcallocn (),
.BR libsimple_evcallocn (),
.BR libsimple_encallocn (),
and
.BR libsimple_ecallocn ()
functions will terminate the process on failure.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.TS
allbox;
lb lb lb
l l l.
Interface Attribute Value
T{
.BR libsimple_vcallocn (),
.br
.BR libsimple_envcallocn (),
.br
.BR libsimple_evcallocn (),
.br
.BR libsimple_callocn (),
.br
.BR libsimple_encallocn (),
.br
.BR libsimple_ecallocn ()
T} Thread safety MT-Safe
T{
.BR libsimple_vcallocn (),
.br
.BR libsimple_envcallocn (),
.br
.BR libsimple_evcallocn (),
.br
.BR libsimple_callocn (),
.br
.BR libsimple_encallocn (),
.br
.BR libsimple_ecallocn ()
T} Async-signal safety AS-Safe
T{
.BR libsimple_vcallocn (),
.br
.BR libsimple_envcallocn (),
.br
.BR libsimple_evcallocn (),
.br
.BR libsimple_callocn (),
.br
.BR libsimple_encallocn (),
.br
.BR libsimple_ecallocn ()
T} Async-cancel safety AC-Safe
.TE
.SH EXAMPLES
None.
.SH APPLICATION USAGE
None.
.SH RATIONALE
None.
.SH FUTURE DIRECTIONS
None.
.SH NOTES
None.
.SH HISTORY
libsimple 1.0
.SH BUGS
None.
.SH SEE ALSO
.BR libsimple_enmalloc (3),
.BR libsimple_mallocz (3),
.BR libsimple_vmallocn (3),
.BR libsimple_vmalloczn (3),
.BR libsimple_encalloc (3),
.BR libsimple_enrealloc (3),
.BR libsimple_reallocarray (3),
.BR libsimple_vreallocn (3),
.BR libsimple_reallocf (3),
.BR libsimple_reallocarrayf (3),
.BR libsimple_vreallocfn (3),
.BR libsimple_aligned_realloc (3),
.BR libsimple_aligned_reallocarray (3),
.BR libsimple_aligned_vreallocn (3),
.BR libsimple_aligned_reallocf (3),
.BR libsimple_aligned_reallocarrayf (3),
.BR libsimple_aligned_vreallocfn (3),
.BR libsimple_memalign (3),
.BR libsimple_memalignz (3),
.BR libsimple_vmemalignn (3),
.BR libsimple_vmemalignzn (3),
.BR libsimple_enposix_memalign (3),
.BR libsimple_posix_memalignz (3),
.BR libsimple_vposix_memalignn (3),
.BR libsimple_vposix_memalignzn (3),
.BR libsimple_enaligned_alloc (3),
.BR libsimple_aligned_allocz (3),
.BR libsimple_valigned_allocn (3),
.BR libsimple_valigned_alloczn (3),
.BR libsimple_pvalloc (3),
.BR libsimple_pvallocz (3),
.BR libsimple_vpvallocn (3),
.BR libsimple_vpvalloczn (3),
.BR libsimple_valloc (3),
.BR libsimple_vallocz (3),
.BR libsimple_vvallocn (3),
.BR libsimple_vvalloczn (3),
.BR libsimple_vmemalloc (3),
.BR libsimple_varrayalloc (3),
.BR calloc (3)
