KGy SOFT Core Libraries Help
String
Encrypts a text by provided symmetric algorithm, key and initialization vector.
Definition
Namespace: KGySoft.CoreLibraries
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 10.0.0
The encrypted result of text in base64 format.
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 10.0.0
C#
public static string Encrypt(
this string text,
SymmetricAlgorithm algorithm,
byte[] key,
byte[] iv,
Encoding? encoding = null
)VB
<ExtensionAttribute>
Public Shared Function Encrypt (
text As String,
algorithm As SymmetricAlgorithm,
key As Byte(),
iv As Byte(),
Optional encoding As Encoding = Nothing
) As StringC++
public:
[ExtensionAttribute]
static String^ Encrypt(
String^ text,
SymmetricAlgorithm^ algorithm,
array<unsigned char>^ key,
array<unsigned char>^ iv,
Encoding^ encoding = nullptr
)F#
[<ExtensionAttribute>]
static member Encrypt :
text : string *
algorithm : SymmetricAlgorithm *
key : byte[] *
iv : byte[] *
?encoding : Encoding
(* Defaults:
let _encoding = defaultArg encoding null
*)
-> string Parameters
- text String
- The source plain text to encrypt.
- algorithm SymmetricAlgorithm
- A SymmetricAlgorithm instance to be used for encryption.
- key Byte
- Key to be used for encryption.
- iv Byte
- Initialization vector to be used for encryption.
- encoding Encoding (Optional)
- An optional Encoding to transcode the text before encryption.
If , then the actual UTF-16 encoding will be used, which can be faster and may allocate less memory, but
the result may be longer if text contains ASCII characters only, for example. This parameter is optional.
Default value: .
Return Value
StringThe encrypted result of text in base64 format.