File: mongoc_gridfs_file_readv.rst

package info (click to toggle)
mongo-c-driver 1.17.6-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 37,256 kB
  • sloc: ansic: 152,613; javascript: 7,954; python: 3,259; sh: 138; makefile: 29; xml: 10
file content (38 lines) | stat: -rw-r--r-- 993 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
:man_page: mongoc_gridfs_file_readv

mongoc_gridfs_file_readv()
==========================

Synopsis
--------

.. code-block:: c

  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 :symbol:`mongoc_gridfs_file_t`.
* ``iov``: An array of :symbol:`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 :symbol:`mongoc_gridfs_file_error` to retrieve error details.