XMediator::Api::InstanceError

Describes an error related to a waterfall instance.

Public Types

	Name
enum class	ErrorType { LoadFailed = 1, Timeout = 2, InitTimeout = 2, InitializationFailed = 3, InvalidConfiguration = 4, InvalidClassname = 5, Unexpected = 6, UnsupportedType = 7, Skipped = 8, ReinitializationUnsupported = 9} Errors that can cause a waterfall instance to fail.

Public Functions

	Name
override bool	Equals(object obj)
override int	GetHashCode()
override string	ToString()

Protected Functions

	Name
bool	Equals(InstanceError other)

Public Properties

	Name
ErrorType	Type The type of error that describes this waterfall instance error. For a complete list of possible values, see ErrorType.
int?	AdapterCode Error code of the underlying adapter, if available.
string	Name Name of the instance that failed, if available.
string	Message A message describing the error, if available.

Public Types Documentation

enum ErrorType

Enumerator	Value	Description
LoadFailed	1
Timeout	2
InitTimeout	2
InitializationFailed	3
InvalidConfiguration	4
InvalidClassname	5
Unexpected	6
UnsupportedType	7
Skipped	8
ReinitializationUnsupported	9

Errors that can cause a waterfall instance to fail.

Public Functions Documentation

function Equals

override bool Equals(
    object obj
)

function GetHashCode

override int GetHashCode()

function ToString

override string ToString()

Protected Functions Documentation

function Equals

bool Equals(
    InstanceError other
)

Public Property Documentation

property Type

ErrorType Type;

The type of error that describes this waterfall instance error. For a complete list of possible values, see ErrorType.

property AdapterCode

int? AdapterCode;

Error code of the underlying adapter, if available.

property Name

string Name;

Name of the instance that failed, if available.

property Message

string Message;

A message describing the error, if available.

---

Updated on 2024-11-07 at 18:31:49 +0000