Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
MONGOC_CLIENT_...YPTION_GET_KEY(3)  libmongoc MONGOC_CLIENT_...YPTION_GET_KEY(3)

SYNOPSIS
	bool
	mongoc_client_encryption_get_key (mongoc_client_encryption_t *client_encryption,
					  const bson_value_t *keyid,
					  bson_t *key_doc,
					  bson_error_t *error);

     Get a key document in the key vault collection that has the given keyid.

PARAMETERS
     * client_encryption: A mongoc_client_encryption_t.

     * keyid: The UUID (BSON binary subtype 0x04) of the key to get.

     * key_doc: Optional. An uninitialized bson_t set to the resulting key docu-
       ment, or an empty document value if the key does not exist. Must be freed
       by bson_destroy().

     * error: Optional. bson_error_t.

RETURNS
     Returns true if successful. Returns false and sets error otherwise.

     SEE ALSO:
	mongoc_client_encryption_t

AUTHOR
     MongoDB, Inc

COPYRIGHT
     2009-present, MongoDB, Inc.

1.30.8				  Aug 27, 2026MONGOC_CLIENT_...YPTION_GET_KEY(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_client_encryption_get_key&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help