File: mongoc_client_set_error_api.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 (27 lines) | stat: -rw-r--r-- 724 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
:man_page: mongoc_client_set_error_api

mongoc_client_set_error_api()
=============================

Synopsis
--------

.. code-block:: c

  bool
  mongoc_client_set_error_api (mongoc_client_t *client, int32_t version);

Configure how the C Driver reports errors. See :ref:`Setting the Error API Version <errors_error_api_version>`.

Do not use this function with pooled clients, see :symbol:`mongoc_client_pool_set_error_api`.

Parameters
----------

* ``client``: A :symbol:`mongoc_client_t`.
* ``version``: The version of the error API, either ``MONGOC_ERROR_API_VERSION_LEGACY`` or ``MONGOC_ERROR_API_VERSION_2``.

Returns
-------

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