ClientEncryptionEncrypt Method |
Encrypts the specified value.
Namespace:
MongoDB.Driver.Encryption
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2
Syntax public BsonBinaryData Encrypt(
BsonValue value,
EncryptOptions encryptOptions,
CancellationToken cancellationToken = default
)
Public Function Encrypt (
value As BsonValue,
encryptOptions As EncryptOptions,
Optional cancellationToken As CancellationToken = Nothing
) As BsonBinaryData
member Encrypt :
value : BsonValue *
encryptOptions : EncryptOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> BsonBinaryData
Parameters
- value
- Type: MongoDB.BsonBsonValue
The value. - encryptOptions
- Type: MongoDB.Driver.EncryptionEncryptOptions
The encrypt options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
BsonBinaryDataThe encrypted value.
See Also