.TH LIBABORT_SAPRINTF 3 LIBABORT
.SH NAME
libabort_saprintf \- Format a string with bounds checking

.SH SYNOPSIS
.nf
#include <libabort.h>

int \fBlibabort_saprintf\fP(char *\fIbuf\fP, size_t \fIsize\fP, const char *\fIfmt\fP, ...);

#if !defined(LIBABORT_NO_SHORTHANDS) && !defined(saprintf)
# define \fBsaprintf\fP libabort_saprintf
#endif
.fi
.PP
Link with
.IR -labort .

.SH DESCRIPTION
The
.BR libabort_saprintf ()
function formats a string according to
.I fmt
into the buffer
.IR buf ,
which is assumed to be
.I size
bytes long.
.PP
If the formatted output does not fit in the destination buffer
(including the terminating NUL byte), or if
.I size
is zero, the
.BR libabort_saprintf ()
function calls
.BR abort (3).

.SH RETURN VALUE
The
.BR libabort_saprintf ()
function returns the number of bytes written to
.IR buf ,
excluding the terminating NUL byte.

.SH ERRORS
The
.BR libabort_saprintf ()
function cannot fail.

.SH HISTORY
The
.BR libabort_saprintf ()
function added in version 1.0 of
.BR libabort .

.SH SEE ALSO
.BR libabort (7),
.BR libabort_vsaprintf (3)