mongoc_cursor_clone(3)
mongoc_cursor_clone()
Description
MONGOC_CURSOR_CLONE
NAME
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
COPYRIGHT
2017-present, MongoDB, Inc