PasswordDeriveBytes::CryptDeriveKey Method (String^, String^, Int32, array<Byte>^)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Derives a cryptographic key from the PasswordDeriveBytes object.

Namespace:   System.Security.Cryptography
Assembly:  mscorlib (in mscorlib.dll)

public:
array<unsigned char>^ CryptDeriveKey(
	String^ algname,
	String^ alghashname,
	int keySize,
	array<unsigned char>^ rgbIV
)

Parameters

algname
Type: System::String^

The algorithm name for which to derive the key.

alghashname
Type: System::String^

The hash algorithm name to use to derive the key.

keySize
Type: System::Int32

The size of the key, in bits, to derive.

rgbIV
Type: array<System::Byte>^

The initialization vector (IV) to use to derive the key.

Return Value

Type: array<System::Byte>^

The derived key.

Exception Condition
CryptographicException

The keySize parameter is incorrect.

-or-

The cryptographic service provider (CSP) cannot be acquired.

-or-

The algname parameter is not a valid algorithm name.

-or-

The alghashname parameter is not a valid hash algorithm name.

This function is a wrapper for the Crypto API function CryptDeriveKey(), and is intended to offer interoperability with applications using the Crypto API.

If the keySize parameter is set to 0 bits, the default key size for the specified algorithm is used.

This code example is part of a larger example provided for the PasswordDeriveBytes class.

// Create the key and set it to the Key property
// of the TripleDESCryptoServiceProvider object.
    cryptoDESProvider->Key = passwordDeriveBytes->CryptDeriveKey
        ("TripleDES", "SHA1", 192, cryptoDESProvider->IV);

.NET Framework
Available since 1.1
Return to top
Show: