Scroll to navigation

MONGOC_CURSOR_CLONE(3) libmongoc MONGOC_CURSOR_CLONE(3)

SYNOPSIS

mongoc_cursor_t *
mongoc_cursor_clone (const mongoc_cursor_t *cursor);


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

2009-present, MongoDB, Inc.

December 11, 2025 2.2.1