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

SYNOPSIS

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

PARAMETERS

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

RETURNS

36       Returns true if successful. Returns false and sets error otherwise.
37
38       SEE ALSO:
39          mongoc_client_encryption_t
40
41

AUTHOR

43       MongoDB, Inc
44
46       2017-present, MongoDB, Inc
47
48
49
50
511.25.1                         MONNoGvOC0_8C,LI2E0N2T3_ENCRYPTION_REMOVE_KEY_ALT_NAME(3)
Impressum