summaryrefslogtreecommitdiffstats
path: root/man/man3/asprintf.3
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-24 04:52:22 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-24 04:52:22 +0000
commit3d08cd331c1adcf0d917392f7e527b3f00511748 (patch)
tree312f0d1e1632f48862f044b8bb87e602dcffb5f9 /man/man3/asprintf.3
parentAdding debian version 6.7-2. (diff)
downloadmanpages-3d08cd331c1adcf0d917392f7e527b3f00511748.tar.xz
manpages-3d08cd331c1adcf0d917392f7e527b3f00511748.zip
Merging upstream version 6.8.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'man/man3/asprintf.3')
-rw-r--r--man/man3/asprintf.370
1 files changed, 70 insertions, 0 deletions
diff --git a/man/man3/asprintf.3 b/man/man3/asprintf.3
new file mode 100644
index 0000000..79d92d5
--- /dev/null
+++ b/man/man3/asprintf.3
@@ -0,0 +1,70 @@
+'\" t
+.\" Copyright (C) 2001 Andries Brouwer <aeb@cwi.nl>
+.\"
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
+.\"
+.\" Text fragments inspired by Martin Schulze <joey@infodrom.org>.
+.\"
+.TH asprintf 3 2024-05-02 "Linux man-pages (unreleased)"
+.SH NAME
+asprintf, vasprintf \- print to allocated string
+.SH LIBRARY
+Standard C library
+.RI ( libc ", " \-lc )
+.SH SYNOPSIS
+.nf
+.BR "#define _GNU_SOURCE" " /* See feature_test_macros(7) */"
+.B #include <stdio.h>
+.P
+.BI "int asprintf(char **restrict " strp ", const char *restrict " fmt ", ...);"
+.BI "int vasprintf(char **restrict " strp ", const char *restrict " fmt ,
+.BI " va_list " ap );
+.fi
+.SH DESCRIPTION
+The functions
+.BR asprintf ()
+and
+.BR vasprintf ()
+are analogs of
+.BR sprintf (3)
+and
+.BR vsprintf (3),
+except that they allocate a string large enough to hold the output
+including the terminating null byte (\[aq]\e0\[aq]),
+and return a pointer to it via the first argument.
+This pointer should be passed to
+.BR free (3)
+to release the allocated storage when it is no longer needed.
+.SH RETURN VALUE
+When successful, these functions return the number of bytes printed,
+just like
+.BR sprintf (3).
+If memory allocation wasn't possible, or some other error occurs,
+these functions will return \-1, and the contents of
+.I strp
+are undefined.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface Attribute Value
+T{
+.na
+.nh
+.BR asprintf (),
+.BR vasprintf ()
+T} Thread safety MT-Safe locale
+.TE
+.SH VERSIONS
+The FreeBSD implementation sets
+.I strp
+to NULL on error.
+.SH STANDARDS
+GNU, BSD.
+.SH SEE ALSO
+.BR free (3),
+.BR malloc (3),
+.BR printf (3)