Man page - bson_reader_read(3)

Packages contains this manual

Manual

BSON_READER_READ

SYNOPSIS
PARAMETERS
DESCRIPTION
RETURNS
EXAMPLE
AUTHOR
COPYRIGHT

SYNOPSIS

const bson_t *
bson_reader_read (bson_reader_t *reader, bool *reached_eof);

PARAMETERS

reader : A bson_reader_t .

reached_eof : A UNKNOWN.

DESCRIPTION

The bson_reader_read() function shall read the next document from the underlying file-descriptor or buffer.

If there are no further documents or a failure was detected, then NULL is returned.

If we reached the end of the sequence, reached_eof is set to true.

To detect an error, check for NULL and reached_of is false.

RETURNS

A bson_t that should not be modified or freed.

EXAMPLE

const bson_t *doc;
bool reached_eof = false;

while ((doc = bson_reader_read (reader, &reached_eof))) {
/* do something */
}

if (!reached_eof) {
fprintf (stderr, "Failed to read all documents.\n");
}

AUTHOR

MongoDB, Inc

COPYRIGHT

2009-present, MongoDB, Inc.