.\" This manpage is Copyright (C) 2016 MongoDB, Inc.
.\" 
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.3
.\" or any later version published by the Free Software Foundation;
.\" with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
.\" A copy of the license is included in the section entitled "GNU
.\" Free Documentation License".
.\" 
.TH "MONGOC_CURSOR_SET_BATCH_SIZE" "3" "2016\(hy10\(hy12" "MongoDB C Driver"
.SH NAME
mongoc_cursor_set_batch_size() \- Limits the number of documents returned in one batch. Each batch requires a round trip to the server. If the batch size is zero, the cursor uses the server-defined maximum batch size.
.SH "SYNOPSIS"

.nf
.nf
void
mongoc_cursor_set_batch_size (mongoc_cursor_t *cursor,
                              uint32_t         batch_size);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
cursor
A
.B mongoc_cursor_t
.
.LP
.TP
.B
batch_size
The requested number of documents per batch.
.LP

.SH "DESCRIPTION"

Limits the number of documents returned in one batch. Each batch requires a round trip to the server. If the batch size is zero, the cursor uses the server\(hydefined maximum batch size.

See
.B Cursor Batches
in the MongoDB Manual.


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