1MONGOC_CLIENT_ENCRYPTION_REMOVE_MKOENYG_lOAiCLb_TmC_oLNnIAgEMoNEcT(_3E)NCRYPTION_REMOVE_KEY_ALT_NAME(3)
2
3
4

NAME

6       mongoc_client_encryption_remove_key_alt_name   -  mongoc_client_encryp‐
7       tion_remove_key_alt_name()
8

SYNOPSIS

10          bool
11          mongoc_client_encryption_remove_key_alt_name (
12             mongoc_client_encryption_t *client_encryption,
13             const bson_value_t *keyid,
14             const char *keyaltname,
15             bson_t *key_doc,
16             bson_error_t *error);
17
18       Remove keyaltname from the set of keyAltNames in the key document  with
19       UUID keyid.
20
21       Also  removes  the  keyAltNames field from the key document if it would
22       otherwise be empty.
23

PARAMETERS

25       • client_encryption: A mongoc_client_encryption_t.
26
27       • keyid: The UUID (BSON binary subtype 0x04) of the key to  remove  the
28         key alternate name from.
29
30       • keyaltname: The key alternate name to remove.
31
32       • key_doc:  Optional.  An  uninitialized bson_t set to the value of the
33         key document before removal of the key alternate name,  or  an  empty
34         document    the    key   does   not   exist.   Must   be   freed   by
35         bson_value_destroy().
36
37       • error: Optional. bson_error_t.
38

RETURNS

40       Returns true if successful. Returns false and sets error otherwise.
41
42       SEE ALSO:
43          mongoc_client_encryption_t
44
45

AUTHOR

47       MongoDB, Inc
48

50       2017-present, MongoDB, Inc
51
52
53
54
551.24.3                         MOANuGgOC1_7C,LI2E0N2T3_ENCRYPTION_REMOVE_KEY_ALT_NAME(3)
Impressum