.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "MONGOC_CURSOR_SET_LIMIT" "3" "May 07, 2024" "1.27.1" "libmongoc"
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
bool
mongoc_cursor_set_limit (mongoc_cursor_t *cursor, int64_t limit);
.EE
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBcursor\fP: A \fI\%mongoc_cursor_t\fP\&.
.IP \(bu 2
\fBlimit\fP: The maximum number of documents to retrieve for this query.
.UNINDENT
.SH DESCRIPTION
.sp
Limits the number of documents in the result set.
.sp
This function is useful for setting the limit on a cursor after the cursor is created, but before any calls to \fI\%mongoc_cursor_next()\fP\&. It can also be used to pass a negative limit: The \fBlimit\fP parameter to \fBmongoc_cursor_set_limit\fP is signed, although for backward\-compatibility reasons the \fBlimit\fP parameter to \fI\%mongoc_collection_find()\fP is not.
.sp
Calling this function after \fI\%mongoc_cursor_next()\fP has no effect.
.sp
This is not applicable to all cursors. Calling \fI\%mongoc_cursor_set_limit()\fP on a cursor returned by \fI\%mongoc_client_find_databases_with_opts()\fP, \fI\%mongoc_database_find_collections_with_opts()\fP, or \fI\%mongoc_collection_find_indexes_with_opts()\fP will not change the results.
.SH RETURNS
.sp
Returns true on success. If any arguments are invalid, returns false and leaves the limit unchanged.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.