Scroll to navigation

MONGOC_GRIDFS_FILE_READV(3) Library Functions Manual MONGOC_GRIDFS_FILE_READV(3)

NAME

mongoc_gridfs_file_readv() - This function performs a scattered read from file, potentially blocking to read from the MongoDB server.

SYNOPSIS


ssize_t mongoc_gridfs_file_readv (mongoc_gridfs_file_t *file, mongoc_iovec_t *iov, size_t iovcnt, size_t min_bytes, uint32_t timeout_msec);

PARAMETERS

file
A mongoc_gridfs_file_t
iov
An array of mongoc_iovec_t
iovcnt
The number of elements in iov
min_bytes
The minimum number of bytes that must be read or an error will be synthesized.
timeout_msec
A uint32_t with the timeout in milliseconds.

DESCRIPTION

This function performs a scattered read from file , potentially blocking to read from the MongoDB server.

Timeout should be the number of milliseconds to allow blocking, or 0 to disallow blocking.

RETURNS

Returns the number of bytes read, or ‐1 on failure. Use mongoc_gridfs_file_error to retrieve error details.

COLOPHON

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