Gemstone Common Library
Data
Encrypts the data in a specified byte array and returns a byte array that contains the encrypted data.
Definition
Namespace: Gemstone.Security.Cryptography
Assembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.147 -- Release Build+759c9d29b79c81f10905de8f58b653be932045f0
A byte array representing the encrypted data.
Assembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.147 -- Release Build+759c9d29b79c81f10905de8f58b653be932045f0
C#
public static byte[] Protect(
byte[] unencryptedData,
byte[]? optionalEntropy = null,
bool protectToLocalMachine = true,
string settingsCategory = "CryptographyServices"
)VB
Public Shared Function Protect (
unencryptedData As Byte(),
Optional optionalEntropy As Byte() = Nothing,
Optional protectToLocalMachine As Boolean = true,
Optional settingsCategory As String = "CryptographyServices"
) As Byte()C++
public:
static array<unsigned char>^ Protect(
array<unsigned char>^ unencryptedData,
array<unsigned char>^ optionalEntropy = nullptr,
bool protectToLocalMachine = true,
String^ settingsCategory = L"CryptographyServices"
)JavaScript
Gemstone.Security.Cryptography.DataProtection.Protect = function(unencryptedData, optionalEntropy, protectToLocalMachine, settingsCategory);Parameters
- unencryptedData Byte
- A byte array that contains data to encrypt.
- optionalEntropy Byte (Optional)
- An optional additional byte array used to increase the complexity of the encryption, or null for no additional complexity.
- protectToLocalMachine Boolean (Optional)
- Set to true to protect data to the local machine; otherwise, set to false to protect data to the current user.
- settingsCategory String (Optional)
- The config file settings category under which the settings are defined.
Return Value
ByteA byte array representing the encrypted data.
Exceptions
| ArgumentNullException | The unencryptedData parameter is null. |
| CryptographicException | The encryption failed. |