Class APIException

Wraps exceptions thrown by the JobTracker instance.

Inheritance

System.Object

System.Exception

APIException

UnsupportedAPIVersionException

Implements

System.Runtime.Serialization.ISerializable

System.Runtime.InteropServices._Exception

Inherited Members

System.Exception.GetBaseException()

System.Exception.ToString()

System.Exception.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext)

System.Exception.GetType()

System.Exception.Message

System.Exception.Data

System.Exception.InnerException

System.Exception.TargetSite

System.Exception.StackTrace

System.Exception.HelpLink

System.Exception.Source

System.Exception.HResult

System.Exception.SerializeObjectState

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.MemberwiseClone()

Namespace: Moraware.JobTrackerAPI5

Assembly: JobTrackerAPI5.dll

Syntax

public class APIException : Exception, ISerializable, _Exception

Constructors

APIException(String, APIException.APIErrorCodes_Enum)

Declaration

public APIException(string message, APIException.APIErrorCodes_Enum apiErrorCode_)

Parameters

Type	Name	Description
System.String	message	The error message.
APIException.APIErrorCodes_Enum	apiErrorCode_	The error code.

APIException(XmlDocument, String, APIException.APIErrorCodes_Enum)

Declaration

public APIException(XmlDocument originalDocument_, string message, APIException.APIErrorCodes_Enum apiErrorCode_)

Parameters

Type	Name	Description
System.Xml.XmlDocument	originalDocument_	The response document that contains the exception.
System.String	message	The error message.
APIException.APIErrorCodes_Enum	apiErrorCode_	The error code.

Properties

APIErrorCode

The underlying error code.

Declaration

public APIException.APIErrorCodes_Enum APIErrorCode { get; }

Property Value

Type	Description
APIException.APIErrorCodes_Enum

OriginalDocument

The response document that contains the exception.

Declaration

public XmlDocument OriginalDocument { get; set; }

Property Value

Type	Description
System.Xml.XmlDocument

Methods

APIErrorCodeDescription(APIException.APIErrorCodes_Enum)

Returns a human-readable interpretation of the given error code.

Declaration

public static string APIErrorCodeDescription(APIException.APIErrorCodes_Enum apiErrorCode_)

Parameters

Type	Name	Description
APIException.APIErrorCodes_Enum	apiErrorCode_	The underlying error code.

Returns

Type	Description
System.String	Description of the given error code.

ConvertToAPIErrorCode(String, ref APIException.APIErrorCodes_Enum)

Coverts the given error code to a corresponding enum value, if possible.

Declaration

public static bool ConvertToAPIErrorCode(string strErrorCode_, ref APIException.APIErrorCodes_Enum apiErrorCode_)

Parameters

Type	Name	Description
System.String	strErrorCode_	A string form of the error code.
APIException.APIErrorCodes_Enum	apiErrorCode_	The converted error code.

Returns

Type	Description
System.Boolean	True if successfully converted.

Implements

System.Runtime.Serialization.ISerializable

System.Runtime.InteropServices._Exception