bson_writer_begin (3) - Linux Manuals

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

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

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.