File: mongoc_client_encryption_encrypt_opts_set_keyid.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 (26 lines) | stat: -rw-r--r-- 762 bytes parent folder | download
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
:man_page: mongoc_client_encryption_encrypt_opts_set_keyid

mongoc_client_encryption_encrypt_opts_set_keyid()
=================================================

Synopsis
--------

.. code-block:: c

   void
   mongoc_client_encryption_encrypt_opts_set_keyid (
      mongoc_client_encryption_encrypt_opts_t *opts, const bson_value_t *keyid);

Identifies the data key to use for encryption. This option is mutually exclusive with :symbol:`mongoc_client_encryption_encrypt_opts_set_keyaltname()`. 

Parameters
----------

* ``opts``: A :symbol:`mongoc_client_encryption_encrypt_opts_t`
* ``keyid``: A UUID (BSON binary with subtype 4) corresponding to the ``_id`` of the data key.

See Also
--------

* :symbol:`mongoc_client_encryption_encrypt_opts_set_keyaltname`