Class ErrorMessage

Describes a single runtime error. An ErrorMessage has an error code, zero or more parameters, generic error text, and localized error text. Error parameters can either be objects of type String or Int32. Objects of this type are immutable.

To create an ErrorMessage object in an event handler, use the
appropriate createErrorMessage
method.

Inheritance

object

ErrorMessage

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: WRQ.Verastream.HostIntegrator

Assembly: WRQ.Verastream.HostIntegrator.dll

Syntax

public class ErrorMessage

Remarks

The methods and properties of this class provide information associated with an error message.

Properties

ErrorCode

Gets the ID number of an error message.

Declaration

public virtual int ErrorCode { get; }

Property Value

Type	Description
int	This property returns the ID number of an error message.

Remarks

Gets the ID number of an error message.

ParameterCount

Gets the number of parameters in an error message.

Declaration

public virtual int ParameterCount { get; }

Property Value

Type	Description
int	This property returns the number of parameters in an error message.

Remarks

Gets the number of parameters in an error message.

Text

Gets the text of an error message.

Declaration

public virtual string Text { get; }

Property Value

Type	Description
string	This property returns the text of an error message.

Remarks

Gets the text of an error message.

Methods

GetParameter(int)

Returns an error parameter string, for an error message.

Declaration

public virtual string GetParameter(int index)

Parameters

Type	Name	Description
int	index	0-based index of the parameter to be obtained.

Returns

Type	Description
string	This method returns a parameter string for an error message.

Remarks

Returns an error parameter string for an error message.

Exceptions

Type	Condition
IndexOutOfRangeException	Thrown when the index value is out of range.