man-pages/man3/asprintf.3.html
2021-03-31 01:06:50 +01:00

132 lines
3.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of ASPRINTF</TITLE>
</HEAD><BODY>
<H1>ASPRINTF</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2019-03-06<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
asprintf, vasprintf - print to allocated string
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>#define _GNU_SOURCE</B> /* See <A HREF="/cgi-bin/man/man2html?7+feature_test_macros">feature_test_macros</A>(7) */
<BR>
<B>#include &lt;<A HREF="file:///usr/include/stdio.h">stdio.h</A>&gt;</B>
<P>
<B>int asprintf(char **</B><I>strp</I><B>, const char *</B><I>fmt</I><B>, ...);</B>
<P>
<B>int vasprintf(char **</B><I>strp</I><B>, const char *</B><I>fmt</I><B>, va_list </B><I>ap</I><B>);</B>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The functions
<B>asprintf</B>()
and
<B>vasprintf</B>()
are analogs of
<B><A HREF="/cgi-bin/man/man2html?3+sprintf">sprintf</A></B>(3)
and
<B><A HREF="/cgi-bin/man/man2html?3+vsprintf">vsprintf</A></B>(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
<B><A HREF="/cgi-bin/man/man2html?3+free">free</A></B>(3)
to release the allocated storage when it is no longer needed.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
When successful, these functions return the number of bytes printed,
just like
<B><A HREF="/cgi-bin/man/man2html?3+sprintf">sprintf</A></B>(3).
If memory allocation wasn't possible, or some other error occurs,
these functions will return -1, and the contents of
<I>strp</I>
are undefined.
<A NAME="lbAF">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>asprintf</B>(),
<B>vasprintf</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe locale<BR></TD></TR>
</TABLE>
<P>
<A NAME="lbAG">&nbsp;</A>
<H2>CONFORMING TO</H2>
These functions are GNU extensions, not in C or POSIX.
They are also available under *BSD.
The FreeBSD implementation sets
<I>strp</I>
to NULL on error.
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+free">free</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+malloc">malloc</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+printf">printf</A></B>(3)
<A NAME="lbAI">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="4"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="5"><A HREF="#lbAF">ATTRIBUTES</A><DD>
<DT id="6"><A HREF="#lbAG">CONFORMING TO</A><DD>
<DT id="7"><A HREF="#lbAH">SEE ALSO</A><DD>
<DT id="8"><A HREF="#lbAI">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:35 GMT, March 31, 2021
</BODY>
</HTML>