MONGOC_CHANGE_STREAM_NEXT(3) libmongoc MONGOC_CHANGE_STREAM_NEXT(3) SYNOPSIS bool mongoc_change_stream_next (mongoc_change_stream_t *stream, const bson_t **bson); This function iterates the underlying cursor, setting bson to the next doc- ument. This will block for a maximum of maxAwaitTimeMS milliseconds as specified in the options when created, or the default timeout if omitted. Data may be returned before the timeout. If no data is returned this func- tion returns false. PARAMETERS * stream: A mongoc_change_stream_t. * bson: The location for the resulting document. RETURNS This function returns true if a valid bson document was read from the stream. Otherwise, false if there was an error or no document was avail- able. Errors can be determined with the mongoc_change_stream_error_document() function. LIFECYCLE Similar to mongoc_cursor_next() the lifetime of bson is until the next call to mongoc_change_stream_next(), so it needs to be copied to extend the lifetime. AUTHOR MongoDB, Inc COPYRIGHT 2009-present, MongoDB, Inc. 1.30.8 Aug 27, 2026 MONGOC_CHANGE_STREAM_NEXT(3)
SYNOPSIS | PARAMETERS | RETURNS | LIFECYCLE | AUTHOR | COPYRIGHT
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_change_stream_next&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>