File: mongoc_read_concern_append.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 (34 lines) | stat: -rw-r--r-- 836 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
:man_page: mongoc_read_concern_append

mongoc_read_concern_append()
============================

Synopsis
--------

.. code-block:: c

  bool
  mongoc_read_concern_append (mongoc_read_concern_t *read_concern, bson_t *opts);

Parameters
----------

* ``read_concern``: A pointer to a :symbol:`mongoc_read_concern_t`.
* ``command``: A pointer to a :symbol:`bson:bson_t`.

Description
-----------

This function appends a read concern to command options. It is useful for appending a read concern to command options before passing them to :symbol:`mongoc_client_read_command_with_opts` or a related function that takes an options document.

Returns
-------

Returns true on success. If any arguments are invalid, returns false and logs an error.

Example
-------

See the example code for :symbol:`mongoc_client_read_command_with_opts`.