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

# mongoc_cursor_new_from_command_reply_with_opts()

## Synopsis

    mongoc_cursor_t *
    mongoc_cursor_new_from_command_reply_with_opts (mongoc_client_t *client,
                                                    bson_t *reply,
                                                    const bson_t *opts);

## Parameters

- `client`: A mongoc_client_t.
- `reply`: The reply to a command, such as “aggregate”, “find”, or “listCollections”, that returns a cursor document. The reply is destroyed by `mongoc_cursor_new_from_command_reply_with_opts` and must not be accessed afterward.
- `opts`: A `bson_t`.

`opts` may be NULL or a BSON document with additional options, which have the same meaning for this function as for mongoc_collection_find_with_opts():

- `awaitData`
- `batchSize`
- `limit`
- `maxAwaitTimeMS`
- `serverId`
- `sessionId`
- `skip`
- `tailable`

## Description

Some MongoDB commands return a “cursor” document. For example, given an “aggregate” command:

    { "aggregate" : "collection", "pipeline" : [], "cursor" : {}}

The server replies:

    {
       "cursor" : {
          "id" : 1234,
          "ns" : "db.collection",
          "firstBatch" : [ ]
       },
       "ok" : 1
    }

`mongoc_cursor_new_from_command_reply_with_opts` is a low-level function that initializes a mongoc_cursor_t from such a reply.

Use this function only for building a language driver that wraps the C Driver. When writing applications in C, higher-level functions such as mongoc_collection_aggregate() are more appropriate, and ensure compatibility with a range of MongoDB versions.

## Returns

A mongoc_cursor_t. On failure, the cursor’s error is set. Check for failure with mongoc_cursor_error().

Created using Sphinx 1.8.3, based on Sphinx Readable Theme.