Scroll to navigation

MONGOC_GRIDFS_FILE_READV(3) libmongoc MONGOC_GRIDFS_FILE_READV(3)

NAME

mongoc_gridfs_file_readv - mongoc_gridfs_file_readv()

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: Unused.

DESCRIPTION

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

The timeout_msec parameter is unused.

RETURNS

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

AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc

October 20, 2022 1.23.1