.\" 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_WRITER_BEGIN" "3" "2016\(hy10\(hy12" "libbson"
.SH NAME
bson_writer_begin() \- Begins writing a new document. The caller may use the bson structure to write out a new BSON document. When completed, the caller must call either bson_writer_end() or bson_writer_rollback().
.SH "SYNOPSIS"

.nf
.nf
bool
bson_writer_begin (bson_writer_t *writer,
                   bson_t       **bson);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
.B writer
A
.B bson_writer_t
.
.LP
.TP
.B
.B bson
A
.B bson_t
.
.LP

.SH "DESCRIPTION"

Begins writing a new document. The caller may use the bson structure to write out a new BSON document. When completed, the caller must call either
.B bson_writer_end(3)
or
.B bson_writer_rollback(3)
.

.SH "RETURNS"

true if there was space in the underlying buffers to begin the document.


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