KGy SOFT Core Libraries Help
String
Encrypts a text by the provided symmetric algorithm and password, using a randomly generated salt.
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,
SymmetricAlgorithm algorithm,
string password,
out byte[] salt,
Encoding? encoding = null
)VB
<ExtensionAttribute>
Public Shared Function Encrypt (
text As String,
algorithm As SymmetricAlgorithm,
password As String,
<OutAttribute> ByRef salt As Byte(),
Optional encoding As Encoding = Nothing
) As StringC++
public:
[ExtensionAttribute]
static String^ Encrypt(
String^ text,
SymmetricAlgorithm^ algorithm,
String^ password,
[OutAttribute] array<unsigned char>^% salt,
Encoding^ encoding = nullptr
)F#
[<ExtensionAttribute>]
static member Encrypt :
text : string *
algorithm : SymmetricAlgorithm *
password : string *
salt : byte[] byref *
?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.
- password String
- Password of encryption.
- salt Byte
- When this method returns, contains the randomly generated salt bytes used to derive the key and initialization vector bytes. This parameter is passed uninitialized.
- 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.