mongoc_cursor_set_limit man page

mongoc_cursor_set_limit() — Limits the number of documents in the result set.

Synopsis

bool
mongoc_cursor_set_limit (mongoc_cursor_t *cursor,
                         int64_t          limit);

Parameters

cursor
A mongoc_cursor_t
limit
The maximum number of documents to retrieve for this query.

Description

Limits the number of documents in the result set.

This function is useful for setting the limit on a cursor after the cursor is created, but before any calls to mongoc_cursor_next limit parameter to mongoc_cursor_set_limit is signed, although for backward‐compatibility reasons the limit parameter to mongoc_collection_find is not.

Calling this function after mongoc_cursor_next has no effect.

Returns

True if the limit was set.

Colophon

This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Info

2016‐10‐20 MongoDB C Driver