mongoc_cursor_next man page

mongoc_cursor_next() — This function shall iterate the underlying cursor, setting bson to the next document.

Synopsis

bool
mongoc_cursor_next (mongoc_cursor_t *cursor,
                    const bson_t   **bson);

Parameters

cursor
A mongoc_cursor_t
bson
A location for a const bson_t *

Description

This function shall iterate the underlying cursor, setting bson to the next document.

This function is a blocking function.

Returns

This function returns true if a valid bson document was read from the cursor. Otherwise, false if there was an error or the cursor was exhausted.

Errors can be determined with the mongoc_cursor_error(3) function.

Lifecycle

The bson objects set in this function are ephemeral and good until the next call. This means that you must copy the returned bson if you wish to retain it beyond the lifetime of a single call to mongoc_cursor_next(3)

Colophon

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

Referenced By

mongoc_collection_aggregate(3), mongoc_cursor_clone(3), mongoc_cursors(3), mongoc_cursor_t(3).

2016‐10‐19 MongoDB C Driver