.\" This manpage is Copyright (C) 2016 MongoDB, Inc.
.\" 
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.3
.\" or any later version published by the Free Software Foundation;
.\" with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
.\" A copy of the license is included in the section entitled "GNU
.\" Free Documentation License".
.\" 
.TH "BSON_SNPRINTF" "3" "2016\(hy10\(hy12" "libbson"
.SH NAME
bson_snprintf() \- This is a portable wrapper around snprintf(). It also enforces a trailing \0 in the resulting string.
.SH "SYNOPSIS"

.nf
.nf
int
bson_snprintf (char       *str,
               size_t      size,
               const char *format,
               ...) BSON_GNUC_PRINTF (3, 4);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
.B str
The destination buffer.
.LP
.TP
.B
.B size
The size of
.B str
.
.LP
.TP
.B
.B format
A printf style format string.
.LP

.SH "DESCRIPTION"

This is a portable wrapper around
.B snprintf(3)
. It also enforces a trailing
.B \0
in the resulting string.

.SH "RETURNS"

The number of bytes written to
.B str
.


.B
.SH COLOPHON
This page is part of libbson.
Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.