File: mongoc_uri_get_auth_mechanism.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 (31 lines) | stat: -rw-r--r-- 583 bytes parent folder | download | duplicates (4)
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
:man_page: mongoc_uri_get_auth_mechanism

mongoc_uri_get_auth_mechanism()
===============================

Synopsis
--------

.. code-block:: c

  const char *
  mongoc_uri_get_auth_mechanism (const mongoc_uri_t *uri);

Parameters
----------

* ``uri``: A :symbol:`mongoc_uri_t`.

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

Fetches the ``authMechanism`` parameter to an URI if provided.

Returns
-------

A string which should not be modified or freed. Returns ``NULL`` if the ``authMechanism`` parameter was not provided to ``uri``.

.. only:: html

  .. include:: includes/seealso/authmechanism.txt