asprintf - Man Page

print to allocated string

Library

Standard C library (libc, -lc)

Synopsis

#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);

Description

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.

Return Value

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.

Attributes

For an explanation of the terms used in this section, see attributes(7).

InterfaceAttributeValue
asprintf(), vasprintf()Thread safetyMT-Safe locale

Standards

These functions are GNU extensions, not in C or POSIX. They are also available under *BSD. The FreeBSD implementation sets strp to NULL on error.

See Also

free(3), malloc(3), printf(3)

Referenced By

lttng_ust_tracef(3), lttng_ust_tracelog(3), mandoc_malloc(3), nbdkit-plugin(3), printf(3), talloc_string(3).

The man page vasprintf(3) is an alias of asprintf(3).

2022-10-09 Linux man-pages 6.01