ArticyApiException Class

The standard exception used when the API has found an expected error

Definition

Namespace: Articy.Api
Assembly: PublicApiTypes (in PublicApiTypes.dll) Version: 1.0.0

C#

[SerializableAttribute]
public class ArticyApiException : Exception

ArticyApiException(ErrorCode)	Create an API exception with a specific error code
ArticyApiException(Int32)	Create an API exception with a specific error code
ArticyApiException(ErrorCode, Exception)	Create an API exception with a specific error code
ArticyApiException(ErrorCode, String)	Create an API exception with a specific error code
ArticyApiException(Int32, Exception)	Create an API exception with a specific error code
ArticyApiException(Int32, String)	Create an API exception with a specific error code
ArticyApiException(ErrorCode, String, Exception)	Create an API exception with a specific error code
ArticyApiException(Int32, String, Exception)	Create an API exception with a specific error code

Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception)
ErrorCode	The error code this exception encapsulates, upper 16 bit are facility code, lower 16 bits are the error number within that facility
ErrorNumber	Getter that extracts the error number from the ErrorCode
FacilityCode	Getter that extracts the facility from the ErrorCode
HelpLink	Gets or sets a link to the help file associated with this exception. (Inherited from Exception)
HResult	Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception)
InnerException	Gets the Exception instance that caused the current exception. (Inherited from Exception)
Message	The formatted message of this exception (Overrides ExceptionMessage)
Source	Gets or sets the name of the application or the object that causes the error. (Inherited from Exception)
StackTrace	Gets a string representation of the immediate frames on the call stack. (Inherited from Exception)
TargetSite	Gets the method that throws the current exception. (Inherited from Exception)

Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetBaseException	When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetObjectData	When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception) Obsolete
GetType	Gets the runtime type of the current instance. (Inherited from Exception)
ToString	Creates and returns a string representation of the current exception. (Inherited from Exception)