Scroll to navigation

MONGOC_CURSOR_GET_BATCH_SIZE(3) libmongoc MONGOC_CURSOR_GET_BATCH_SIZE(3)

SYNOPSIS

uint32_t
mongoc_cursor_get_batch_size (const mongoc_cursor_t *cursor);


PARAMETERS

cursor: A mongoc_cursor_t <>.

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 Cursor Batches <https://www.mongodb.com/docs/manual/core/cursors/#cursor-batches> in the MongoDB Manual.

Author

MongoDB, Inc

Copyright

2009-present, MongoDB, Inc.

December 11, 2025 2.2.1