table of contents
MONGOC_CURSOR_CLONE(3) | Library Functions Manual | MONGOC_CURSOR_CLONE(3) |
NAME¶
mongoc_cursor_clone() - 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.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 mongoc_cursor_next(3) is called.RETURNS¶
A newly allocated mongoc_cursor_t that should be freed with mongoc_cursor_destroy(3) when no longer in use.NOTE
Failure to handle the result of this function is a
programming error.
COLOPHON¶
This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.2016‐10‐12 | MongoDB C Driver |