CryptographicException Constructors

Definition

Namespace:

System.Security.Cryptography

Assembly:

System.Runtime.dll

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

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

public:
 CryptographicException();

public CryptographicException ();

Public Sub New ()

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 = gcnew CryptographicException;

CryptographicException cryptographicException =
    new CryptographicException();

Dim cryptographicException As 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.

CryptographicException(Int32)

Source:

CryptographicException.cs

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

public:
 CryptographicException(int hr);

public CryptographicException (int hr);

new System.Security.Cryptography.CryptographicException : int -> System.Security.Cryptography.CryptographicException

Public Sub New (hr As Integer)

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 = (int)0x80131431;
CryptographicException^ cryptographicException = gcnew CryptographicException( exceptionNumber );

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

Dim exceptionNumber As Integer = &H80131431
Dim cryptographicException As _
    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.

CryptographicException(String)

Source:

CryptographicException.cs

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

public:
 CryptographicException(System::String ^ message);

public CryptographicException (string? message);

new System.Security.Cryptography.CryptographicException : string -> System.Security.Cryptography.CryptographicException

Public Sub New (message As String)

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 = (L"Unexpected Operation exception.");
CryptographicException^ cryptographicException = gcnew CryptographicException( errorMessage );

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

Dim errorMessage As String = "Unexpected Operation exception."
Dim cryptographicException As 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.

CryptographicException(SerializationInfo, StreamingContext)

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);

[<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}")>]
new System.Security.Cryptography.CryptographicException : System.Runtime.Serialization.SerializationInfo * System.Runtime.Serialization.StreamingContext -> System.Security.Cryptography.CryptographicException

Protected Sub New (info As SerializationInfo, context As StreamingContext)

Parameters

info

SerializationInfo

The object that holds the serialized object data.

context

StreamingContext

The contextual information about the source or destination.

Attributes

ObsoleteAttribute

Remarks

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

CryptographicException(String, Exception)

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(System::String ^ message, Exception ^ inner);

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

new System.Security.Cryptography.CryptographicException : string * Exception -> System.Security.Cryptography.CryptographicException

Public Sub New (message As String, inner As Exception)

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 = (L"The current operation is not supported.");
NullReferenceException^ nullException = gcnew NullReferenceException;
CryptographicException^ cryptographicException = gcnew CryptographicException( errorMessage,nullException );

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

Dim errorMessage As String = "The current operation is not supported."
Dim nullException As New NullReferenceException
Dim cryptographicException As _
    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

• Exception
• Handling and Throwing Exceptions

CryptographicException(String, String)

Source:

CryptographicException.cs

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

public:
 CryptographicException(System::String ^ format, System::String ^ insert);

public CryptographicException (string format, string? insert);

new System.Security.Cryptography.CryptographicException : string * string -> System.Security.Cryptography.CryptographicException

Public Sub New (format As String, insert As String)

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 = L"{0:t}";
String^ timeStamp = (DateTime::Now.ToString());
CryptographicException^ cryptographicException = gcnew CryptographicException( dateFormat,timeStamp );

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

Dim dateFormat As String = "{0:t}"
Dim timeStamp As String = DateTime.Now.ToString()
Dim cryptographicException As _
    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.