.\" 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_GET_LENGTH" "3" "2016\(hy10\(hy12" "libbson"
.SH 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.
.SH "SYNOPSIS"

.nf
.nf
size_t
bson_writer_get_length (bson_writer_t *writer);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
.B writer
A
.B bson_writer_t
.
.LP

.SH "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
.B bson_writer_rollback(3)
to abort the current document being written.

.SH "RETURNS"

The length of the underlying buffer.


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