Function mongocrypt_sys::mongocrypt_ctx_setopt_key_alt_name

source · 
pub unsafe extern "C" fn mongocrypt_ctx_setopt_key_alt_name(
    ctx: *mut mongocrypt_ctx_t,
    key_alt_name: *mut mongocrypt_binary_t,
) -> bool
Expand description

Set the keyAltName to use for explicit encryption or data key creation.

Pass the binary encoding a BSON document like the following:

{ “keyAltName” : (BSON UTF8 value) }

For explicit encryption, it is an error to set both the keyAltName and the key id.

For creating data keys, call this function repeatedly to set multiple keyAltNames.

@param[in] ctx The @ref mongocrypt_ctx_t object. @param[in] key_alt_name The name to use. The viewed data is copied. It is valid to destroy @p key_alt_name with @ref mongocrypt_binary_destroy immediately after. @pre @p ctx has not been initialized. @returns A boolean indicating success. If false, an error status is set. Retrieve it with @ref mongocrypt_ctx_status