.TH LIBSIMPLE_ALIGNED_STRDUP 3 libsimple
.SH NAME
libsimple_aligned_strdup, libsimple_aligned_strdupa \- duplicate a string
.SH SYNOPSIS
.nf
#include <libsimple.h>
char *libsimple_aligned_strdupa(const char *\fIs\fP, size_t \fIn\fP);
char *libsimple_aligned_strdup(const char *\fIs\fP, size_t \fIn\fP);
char *libsimple_enaligned_strdup(int \fIstatus\fP, const char *\fIs\fP, size_t \fIn\fP);
inline char *libsimple_ealigned_strdup(const char *\fIs\fP, size_t \fIn\fP);
#ifndef aligned_strdupa
# define aligned_strdupa libsimple_aligned_strdupa
#endif
#ifndef aligned_strdup
# define aligned_strdup libsimple_aligned_strdup
#endif
#ifndef enaligned_strdup
# define enaligned_strdup libsimple_enaligned_strdup
#endif
#ifndef ealigned_strdup
# define ealigned_strdup libsimple_ealigned_strdup
#endif
.fi
.PP
Link with
.IR \-lsimple .
.SH DESCRIPTION
The
.BR libsimple_aligned_strdup ()
function allocates memory with the alignment
specified in the
.I alignment
parameter and copies the string
.I s
into the new allocation.
.PP
The
.BR libsimple_enaligned_strdup ()
and
.BR libsimple_ealigned_strdup ()
functions are versions of the
.BR libsimple_aligned_strdup ()
function that call the
.BR libsimple_enprintf (3)
function on failure, causing the process to print
an error message and exit. See
.BR libsimple_enprintf (3)
for more information.
.PP
The
.BR libsimple_strdupa ()
function is implemented as a macro and is a version
of the
.BR libsimple_strdup ()
function that uses allocates the memory on the stack
rather than on the heap, causing the return pointer
to become invalid when the calling function returns.
It is only available when compling with GCC or Clang.
.SH RETURN VALUE
Upon successful completion, the
.BR libsimple_aligned_strdupa (),
.BR libsimple_aligned_strdup (),
.BR libsimple_enaligned_strdup (),
and
.BR libsimple_ealigned_strdup ()
functions return a non-null pointer, on failure the
.BR libsimple_aligned_strdup ()
function returns
.B NULL
and set
.I errno
to indicate the error, and the
.BR libsimple_enaligned_strdup (),
and
.BR libsimple_ealigned_strdup ()
functions exit the process. The
.BR libsimple_aligned_strdupa ()
function cannot fail, however the kernel
can kill the thread, and possibly the process, with a
.B SIGSEGV
signal if the memory cannot be allocated.
.PP
The returned pointer should be deallocated when it
is no longer needed, except for the pointer returned
by the
.BR libsimple_aligned_strdupa ()
function, it is automatically deallocated when the
calling function returns.
.SH ERRORS
The
.BR libsimple_aligned_strdup ()
function may fail for any reason specified for the
.BR aligned_alloc (3)
function.
.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_aligned_strdupa (),
.br
.BR libsimple_aligned_strdup (),
.br
.BR libsimple_enaligned_strdup (),
.br
.BR libsimple_ealigned_strdup (),
T} Thread safety MT-Safe
T{
.BR libsimple_aligned_strdupa (),
.br
.BR libsimple_aligned_strdup (),
.br
.BR libsimple_enaligned_strdup (),
.br
.BR libsimple_ealigned_strdup (),
T} Async-signal safety AS-Safe
T{
.BR libsimple_aligned_strdupa (),
.br
.BR libsimple_aligned_strdup (),
.br
.BR libsimple_enaligned_strdup (),
.br
.BR libsimple_ealigned_strdup (),
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 BUGS
None.
.SH SEE ALSO
.BR libsimple_aligned_strndup (3),
.BR libsimple_aligned_memdup (3),
.BR libsimple_aligned_wcsdup (3),
.BR libsimple_aligned_wcsndup (3),
.BR libsimple_aligned_wmemdup (3),
.BR strdup (3)
