Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

CngAlgorithm Class

Encapsulates the name of an encryption algorithm.

System.Object
  System.Security.Cryptography.CngAlgorithm

Namespace:  System.Security.Cryptography
Assembly:  System.Core (in System.Core.dll)
[SerializableAttribute]
[HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)]
public sealed class CngAlgorithm : IEquatable<CngAlgorithm>

The CngAlgorithm type exposes the following members.

  NameDescription
Public methodCngAlgorithmInitializes a new instance of the CngAlgorithm class.
Top
  NameDescription
Public propertyAlgorithmGets the algorithm name that the current CngAlgorithm object specifies.
Public propertyStatic memberECDiffieHellmanP256Gets a CngAlgorithm object that specifies an Elliptic Curve Diffie-Hellman (ECDH) key exchange algorithm that uses the P-256 curve.
Public propertyStatic memberECDiffieHellmanP384Gets a CngAlgorithm object that specifies an Elliptic Curve Diffie-Hellman (ECDH) key exchange algorithm that uses the P-384 curve.
Public propertyStatic memberECDiffieHellmanP521Gets a CngAlgorithm object that specifies an Elliptic Curve Diffie-Hellman (ECDH) key exchange algorithm that uses the P-521 curve.
Public propertyStatic memberECDsaP256Gets a CngAlgorithm object that specifies an Elliptic Curve Digital Signature Algorithm (ECDSA) that uses the P-256 curve.
Public propertyStatic memberECDsaP384Gets a CngAlgorithm object that specifies an Elliptic Curve Digital Signature Algorithm (ECDSA) that uses the P-384 curve.
Public propertyStatic memberECDsaP521Gets a new CngAlgorithm object that specifies an Elliptic Curve Digital Signature Algorithm (ECDSA) that uses the P-521 curve.
Public propertyStatic memberMD5Gets a new CngAlgorithm object that specifies the Message Digest 5 (MD5) hash algorithm.
Public propertyStatic memberSha1Gets a new CngAlgorithm object that specifies the Secure Hash Algorithm 1 (SHA-1) algorithm.
Public propertyStatic memberSha256Gets a new CngAlgorithm object that specifies the Secure Hash Algorithm 256 (SHA-256) algorithm.
Public propertyStatic memberSha384Gets a new CngAlgorithm object that specifies the Secure Hash Algorithm 384 (SHA-384) algorithm.
Public propertyStatic memberSha512Gets a new CngAlgorithm object that specifies the Secure Hash Algorithm 512 (SHA-512) algorithm.
Top
  NameDescription
Public methodEquals(CngAlgorithm)Compares the specified CngAlgorithm object to the current CngAlgorithm object.
Public methodEquals(Object)Compares the specified object to the current CngAlgorithm object. (Overrides Object.Equals(Object).)
Public methodGetHashCodeGenerates a hash value for the algorithm name that is embedded in the current CngAlgorithm object. (Overrides Object.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringGets the name of the algorithm that the current CngAlgorithm object specifies. (Overrides Object.ToString().)
Top
  NameDescription
Public operatorStatic memberEqualityDetermines whether two CngAlgorithm objects specify the same algorithm name.
Public operatorStatic memberInequalityDetermines whether two CngAlgorithm objects do not specify the same algorithm.
Top

The CngAlgorithm class is a utility class. It consists of static properties, comparison methods, and a private, internally maintained, algorithm name string.

The static properties return CngAlgorithm objects. Each object's internal string is initialized to the algorithm name that corresponds to the name of the static property.

You can also use this class to create objects for algorithm types that are not covered by the static properties.

Several Cryptography Next Generation (CNG) classes (such as CngKey) accept CngAlgorithm objects through an algorithm parameter. When the class receives the CngAlgorithm object, it retrieves the embedded algorithm name by calling the object's Algorithm property.

Therefore, CngAlgorithm serves as an enumeration of well-known algorithms. It lets you specify a well-known algorithm by using a strongly typed value instead of a string.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.