bson_writer_begin man page

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().

Synopsis

bool
bson_writer_begin (bson_writer_t *writer,
                   bson_t       **bson);

Parameters

writer
A bson_writer_t
bson
A bson_t

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 bson_writer_end(3) or bson_writer_rollback(3)

Returns

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

Colophon

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

Referenced By

bson_destroy_with_steal(3), bson_streaming_bson(3).

2016‐10‐28 libbson