mongoc_cursor_clone man page

mongoc_cursor_clone — mongoc_cursor_clone()

Synopsis

mongoc_cursor_t *
mongoc_cursor_clone (const mongoc_cursor_t *cursor)
   BSON_GNUC_WARN_UNUSED_RESULT;

Parameters

  • cursor: A mongoc_cursor_t.

Description

This function shall create a copy of a mongoc_cursor_t. The cloned cursor will be reset to the beginning of the query, and therefore the query will be re-executed on the MongoDB server when mongoc_cursor_next() is called.

Returns

A newly allocated mongoc_cursor_t that should be freed with mongoc_cursor_destroy() when no longer in use.

WARNING:

Failure to handle the result of this function is a programming error.

Author

MongoDB, Inc

Info

Mar 08, 2017 1.6.1 MongoDB C Driver