1MONGOC_CURSOR_NEXT(3)              libmongoc             MONGOC_CURSOR_NEXT(3)
2
3
4

SYNOPSIS

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

PARAMETERS

10       • cursor: A mongoc_cursor_t.
11
12       • bson: A location for a bson_t.
13

DESCRIPTION

15       This  function shall iterate the underlying cursor, setting bson to the
16       next document.
17
18       This function is a blocking function.
19

RETURNS

21       This function returns true if a valid bson document was read  from  the
22       cursor.  Otherwise,  false  if there was an error or the cursor was ex‐
23       hausted.
24
25       Errors can be determined with the mongoc_cursor_error() function.
26

LIFECYCLE

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

AUTHOR

34       MongoDB, Inc
35

37       2017-present, MongoDB, Inc
38
39
40
41
421.25.1                           Nov 08, 2023            MONGOC_CURSOR_NEXT(3)
Impressum