KGy SOFT Core Libraries Help
String
Encrypts a text by the Aes algorithm using a randomly generated key and initialization vector, which are
returned in key and iv parameters, respectively.
Definition
Namespace: KGySoft.CoreLibraries
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 10.0.0
The encrypted result of text.
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 10.0.0
C#
public static string Encrypt(
this string text,
out byte[] key,
out byte[] iv,
Encoding? encoding = null
)VB
<ExtensionAttribute>
Public Shared Function Encrypt (
text As String,
<OutAttribute> ByRef key As Byte(),
<OutAttribute> ByRef iv As Byte(),
Optional encoding As Encoding = Nothing
) As StringC++
public:
[ExtensionAttribute]
static String^ Encrypt(
String^ text,
[OutAttribute] array<unsigned char>^% key,
[OutAttribute] array<unsigned char>^% iv,
Encoding^ encoding = nullptr
)F#
[<ExtensionAttribute>]
static member Encrypt :
text : string *
key : byte[] byref *
iv : byte[] byref *
?encoding : Encoding
(* Defaults:
let _encoding = defaultArg encoding null
*)
-> string Parameters
- text String
- The source plain text to encrypt.
- key Byte
- Returns the automatically generated key used for encryption.
- iv Byte
- Returns the automatically generated initialization vector 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.