mongoc_cursor_clone() — MongoDB C Driver 1.9.2

- MongoDB C Driver 1.9.2 »
- API Reference »
- mongoc_cursor_t

# 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.

Created using Sphinx 1.6.5, based on Sphinx Readable Theme.