bson_writer_get_length (3) - Linux Manuals

bson_writer_get_length: Fetches the current length of the content written by the buffer (including the initial offset). This includes a partly written document currently being written.

Command to display bson_writer_get_length manual in Linux: $ man 3 bson_writer_get_length

NAME

bson_writer_get_length() - Fetches the current length of the content written by the buffer (including the initial offset). This includes a partly written document currently being written.

SYNOPSIS

size_t
bson_writer_get_length (bson_writer_t *writer);

PARAMETERS

writer: A bson_writer_t \&.

DESCRIPTION

Fetches the current length of the content written by the buffer (including the initial offset). This includes a partly written document currently being written.

This is useful if you want to check to see if you've passed a given memory boundry that cannot be sent in a packet. See bson_writer_rollback(3) to abort the current document being written.

RETURNS

The length of the underlying buffer.

COLOPHON

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