NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUE | ATTRIBUTES | VERSIONS | STANDARDS | SEE ALSO | COLOPHON |
|
|
asprintf(3) Library Functions Manual asprintf(3)
asprintf, vasprintf - print to allocated string
Standard C library (libc, -lc)
#define _GNU_SOURCE /* See feature_test_macros(7) */ #include <stdio.h> int asprintf(char **restrict strp, const char *restrict fmt, ...); int vasprintf(char **restrict strp, const char *restrict fmt, va_list ap);
The functions asprintf() and vasprintf() are analogs of sprintf(3) and vsprintf(3), except that they allocate a string large enough to hold the output including the terminating null byte ('\0'), and return a pointer to it via the first argument. This pointer should be passed to free(3) to release the allocated storage when it is no longer needed.
When successful, these functions return the number of bytes printed, just like sprintf(3). If memory allocation wasn't possible, or some other error occurs, these functions will return -1, and the contents of strp are undefined.
For an explanation of the terms used in this section, see attributes(7). ┌──────────────────────────────┬───────────────┬────────────────┐ │ Interface │ Attribute │ Value │ ├──────────────────────────────┼───────────────┼────────────────┤ │ asprintf(), vasprintf() │ Thread safety │ MT-Safe locale │ └──────────────────────────────┴───────────────┴────────────────┘
The FreeBSD implementation sets strp to NULL on error.
GNU, BSD.
free(3), malloc(3), printf(3)
This page is part of the man-pages (Linux kernel and C library
user-space interface documentation) project. Information about
the project can be found at
⟨https://www.kernel.org/doc/man-pages/⟩. If you have a bug report
for this manual page, see
⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
This page was obtained from the tarball man-pages-6.9.1.tar.gz
fetched from
⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
2024-06-26. If you discover any rendering problems in this HTML
version of the page, or you believe there is a better or more up-
to-date source for the page, or you have corrections or
improvements to the information in this COLOPHON (which is not
part of the original manual page), send a mail to
[email protected]
Linux man-pages 6.9.1 2024-06-15 asprintf(3)
Pages that refer to this page: lttng_ust_tracef(3), lttng_ust_tracelog(3), printf(3), printf.h(3head)