Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MONGOC_CURSOR_NEXT(3)		   libmongoc		 MONGOC_CURSOR_NEXT(3)

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

PARAMETERS
        cursor: A mongoc_cursor_t.

        bson: A location for a	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 ex-
       hausted.

       Errors can be determined	with the mongoc_cursor_error() 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().

AUTHOR
       MongoDB,	Inc

COPYRIGHT
       2009-present, MongoDB, Inc.

1.30.2				 Apr 12, 2025		 MONGOC_CURSOR_NEXT(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_cursor_next&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help