.\" 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_GET_BATCH_SIZE" "3" "2016\(hy10\(hy12" "MongoDB C Driver"
.SH NAME
mongoc_cursor_get_batch_size() \- Retrieve the cursor's batch size, the maximum number of documents returned per round trip to the server. A batch size of zero means the cursor accepts the server's maximum batch size.
.SH "SYNOPSIS"

.nf
.nf
uint32_t
mongoc_cursor_get_batch_size (const mongoc_cursor_t *cursor);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
cursor
A
.B mongoc_cursor_t
.
.LP

.SH "DESCRIPTION"

Retrieve the cursor's batch size, the maximum number of documents returned per round trip to the server. A batch size of zero means the cursor accepts the server's 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.