CryptographicException Constructors

Definition

Initializes a new instance of the CryptographicException class.

Overloads

CryptographicException()

Initializes a new instance of the CryptographicException class with default properties.

CryptographicException(Int32)

Initializes a new instance of the CryptographicException class with the specified HRESULT error code.

CryptographicException(String)

Initializes a new instance of the CryptographicException class with a specified error message.

CryptographicException(SerializationInfo, StreamingContext)
Obsolete.

Initializes a new instance of the CryptographicException class with serialized data.

CryptographicException(String, Exception)

Initializes a new instance of the CryptographicException class with a specified error message and a reference to the inner exception that is the cause of this exception.

CryptographicException(String, String)

Initializes a new instance of the CryptographicException class with a specified error message in the specified format.

CryptographicException()

Source:
CryptographicException.cs
Source:
CryptographicException.cs
Source:
CryptographicException.cs

Initializes a new instance of the CryptographicException class with default properties.

public CryptographicException ();

Examples

The following code example demonstrates how to construct a CryptographicException with no parameters. This code example is part of a larger example provided for the CryptographicException class.

CryptographicException cryptographicException =
    new CryptographicException();

Remarks

The following table shows the initial property values for an instance of CryptographicException.

Property Value
InnerException null.
Message The localized error message string.

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1

CryptographicException(Int32)

Source:
CryptographicException.cs
Source:
CryptographicException.cs
Source:
CryptographicException.cs

Initializes a new instance of the CryptographicException class with the specified HRESULT error code.

public CryptographicException (int hr);

Parameters

hr
Int32

The HRESULT error code.

Examples

The following code example demonstrates how to construct a CryptographicException using an error code for an CryptographicUnexpectedOperationException. This code example is part of a larger example provided for the CryptographicException class.

int exceptionNumber = unchecked((int)0x80131431);
CryptographicException cryptographicException =
    new CryptographicException(exceptionNumber);

Remarks

The CryptographicException constructor accepts a system HRESULT error code and sets the Message property to a localized message that corresponds to the HRESULT.

The following table shows the initial property values for an instance of CryptographicException.

Property Value
InnerException null.
Message The localized error message string.

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1

CryptographicException(String)

Source:
CryptographicException.cs
Source:
CryptographicException.cs
Source:
CryptographicException.cs

Initializes a new instance of the CryptographicException class with a specified error message.

public CryptographicException (string? message);
public CryptographicException (string message);

Parameters

message
String

The error message that explains the reason for the exception.

Examples

The following code example demonstrates how to construct a CryptographicException using a custom error message. This code example is part of a larger example provided for the CryptographicException class.

string errorMessage = ("Unexpected Operation exception.");
CryptographicException cryptographicException =
    new CryptographicException(errorMessage);

Remarks

The following table shows the initial property values for an instance of CryptographicException.

Property Value
InnerException null.
Message The error message string.

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1

CryptographicException(SerializationInfo, StreamingContext)

Source:
CryptographicException.cs
Source:
CryptographicException.cs
Source:
CryptographicException.cs

Caution

This API supports obsolete formatter-based serialization. It should not be called or extended by application code.

Initializes a new instance of the CryptographicException class with serialized data.

protected CryptographicException (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);
[System.Obsolete("This API supports obsolete formatter-based serialization. It should not be called or extended by application code.", DiagnosticId="SYSLIB0051", UrlFormat="https://aka.ms/dotnet-warnings/{0}")]
protected CryptographicException (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);

Parameters

info
SerializationInfo

The object that holds the serialized object data.

context
StreamingContext

The contextual information about the source or destination.

Attributes

Remarks

This constructor is called during deserialization to reconstitute the exception object transmitted over a stream.

Applies to

.NET 9 and other versions
Product Versions (Obsolete)
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7 (8, 9)
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

CryptographicException(String, Exception)

Source:
CryptographicException.cs
Source:
CryptographicException.cs
Source:
CryptographicException.cs

Initializes a new instance of the CryptographicException class with a specified error message and a reference to the inner exception that is the cause of this exception.

public CryptographicException (string? message, Exception? inner);
public CryptographicException (string message, Exception inner);

Parameters

message
String

The error message that explains the reason for the exception.

inner
Exception

The exception that is the cause of the current exception. If the inner parameter is not null, the current exception is raised in a catch block that handles the inner exception.

Examples

The following code example demonstrates how to construct a CryptographicException using a custom error message and an inner exception. This code example is part of a larger example provided for the CryptographicException class.

string errorMessage = ("The current operation is not supported.");
NullReferenceException nullException = new NullReferenceException();
CryptographicException cryptographicException = 
    new CryptographicException(errorMessage, nullException);

Remarks

An exception that is thrown as a direct result of a previous exception should include a reference to the previous exception in the InnerException property. The InnerException property returns the same value that is passed into the constructor, or null if the InnerException property does not supply the inner exception value to the constructor.

The following table shows the initial property values for an instance of CryptographicException.

Property Value
InnerException The inner exception reference.
Message The error message string.

See also

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1

CryptographicException(String, String)

Source:
CryptographicException.cs
Source:
CryptographicException.cs
Source:
CryptographicException.cs

Initializes a new instance of the CryptographicException class with a specified error message in the specified format.

public CryptographicException (string format, string? insert);
public CryptographicException (string format, string insert);

Parameters

format
String

The format used to output the error message.

insert
String

The error message that explains the reason for the exception.

Examples

The following code example demonstrates how to construct a CryptographicException using a time format and the current date. This code example is part of a larger example provided for the CryptographicException class.

string dateFormat = "{0:t}";
string timeStamp = (DateTime.Now.ToString());
CryptographicException cryptographicException = 
    new CryptographicException(dateFormat, timeStamp);

Remarks

The following table shows the initial property values for an instance of CryptographicException.

Property Value
InnerException null.
Message The error message string.

Applies to

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1