.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "VSNPRINTF" "9" "09 October 2005" "" ""

.SH NAME
vsnprintf \- Format a string and place it in a buffer
.SH SYNOPSIS
"SYNOPSIS"
.sp
\fB
.sp
int vsnprintf  (char * \fIbuf\fB, size_t \fIsize\fB, const char * \fIfmt\fB, va_list \fIargs\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIbuf\fB\fR
The buffer to place the result into
.TP
\fB\fIsize\fB\fR
The size of the buffer, including the trailing null space
.TP
\fB\fIfmt\fB\fR
The format string to use
.TP
\fB\fIargs\fB\fR
Arguments for the format string
.SH "DESCRIPTION"
.PP
The return value is the number of characters which would
be generated for the given input, excluding the trailing
'\\0', as per ISO C99. If you want to have the exact
number of characters written into \fIbuf\fR as return value
(not including the trailing '\\0'), use vscnprintf. If the
return is greater than or equal to \fIsize\fR, the resulting
string is truncated.
.PP
Call this function if you are already dealing with a va_list.
You probably want snprintf instead.