This function returns a newly allocated mongoc_cursor_t that should be freed with mongoc_cursor_destroy
when no longer in use. The returned mongoc_cursor_t is never NULL
, even on error. The user must call
mongoc_cursor_next on the returned mongoc_cursor_t to execute the initial command.
Cursor errors can be checked with mongoc_cursor_error_document. It always fills out the bson_error_t if an error occurred, and optionally includes a server reply document if the error occurred server-side.
Warning
Failure to handle the result of this function is a programming error.