1MONGOC_CLIENT_ENCRYPTION_ENCRYPT(3)libmongocMONGOC_CLIENT_ENCRYPTION_ENCRYPT(3)
2
3
4
6 mongoc_client_encryption_encrypt - mongoc_client_encryption_encrypt()
7
9 bool
10 mongoc_client_encryption_encrypt (
11 mongoc_client_encryption_t *client_encryption,
12 const bson_value_t *value,
13 mongoc_client_encryption_encrypt_opts_t *opts,
14 bson_value_t *ciphertext,
15 bson_error_t *error);
16
17 Performs explicit encryption.
18
19 ciphertext is always initialized (even on failure). Caller must call
20 bson_value_destroy() to free.
21
23 • client_encryption: A mongoc_client_encryption_t
24
25 • value: The value to encrypt.
26
27 • opts: A mongoc_client_encryption_encrypt_opts_t.
28
29 • ciphertext: A bson_value_t for the resulting ciphertext (a BSON bi‐
30 nary with subtype 6).
31
32 • error: A bson_error_t set on failure.
33
35 Returns true if successful. Returns false and sets error otherwise.
36
37 SEE ALSO:
38 mongoc_client_encryption_encrypt_opts_t
39
40 mongoc_client_enable_auto_encryption()
41
42 mongoc_client_encryption_decrypt()
43
44
46 MongoDB, Inc
47
49 2017-present, MongoDB, Inc
50
51
52
53
541.20.0 Nov 18, 202M1ONGOC_CLIENT_ENCRYPTION_ENCRYPT(3)