bson_writer_begin() — libbson 1.6.3

- libbson 1.6.3 »
- API Reference »
- bson_writer_t

# bson_writer_begin()

## 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() or bson_writer_rollback().

## Returns

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

Created using Sphinx 1.5.3, based on Sphinx Readable Theme.