Class ApptrieveException

The ApptrieveException class provides information on errors that occur during the use of a Host Integrator Server.

Inheritance

object

Exception

ApplicationException

ApptrieveException

Implements

ISerializable

_Exception

Inherited Members

Exception.GetBaseException()

Exception.ToString()

Exception.GetType()

Exception.Data

Exception.InnerException

Exception.TargetSite

Exception.StackTrace

Exception.HelpLink

Exception.Source

Exception.HResult

Exception.SerializeObjectState

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.MemberwiseClone()

Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI

Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll

Syntax

[Serializable]
public class ApptrieveException : ApplicationException, ISerializable, _Exception

Constructors

ApptrieveException(ErrorMessage)

Create using an ErrorMessage object.

Declaration

public ApptrieveException(ErrorMessage errorMesg)

Parameters

Type	Name	Description
ErrorMessage	errorMesg	error message

ApptrieveException(IList<ErrorMessage>)

Create using a list of ErrorMessage objects.

Declaration

public ApptrieveException(IList<ErrorMessage> errorList)

Parameters

Type	Name	Description
IList<ErrorMessage>	errorList	a list of ErrorMessage objects

ApptrieveException(IList<string>, IList<string>)

Create using a list of error descriptions.

Declaration

public ApptrieveException(IList<string> mesgs, IList<string> localizedMesgs)

Parameters

Type	Name	Description
IList<string>	mesgs	list of generic message strings
IList<string>	localizedMesgs	list of localized message strings

ApptrieveException(SerializationInfo, StreamingContext)

Initializes a new instance of the ApplicationException class with serialized data.

Declaration

protected ApptrieveException(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
SerializationInfo	info	The object that holds the serialized object data.
StreamingContext	context	The contextual information about the source or destination.

ApptrieveException(string)

Create using a simple string message.

Declaration

public ApptrieveException(string mesg)

Parameters

Type	Name	Description
string	mesg	error text

ApptrieveException(string, string)

Create using an error description string.

Declaration

public ApptrieveException(string mesg, string localizedMesg)

Parameters

Type	Name	Description
string	mesg	generic message string
string	localizedMesg	localized message string

Properties

ErrorMessage

Gets the first error message in the exception.

Declaration

public virtual ErrorMessage ErrorMessage { get; }

Property Value

Type	Description
ErrorMessage	returns error message

ErrorMessageList

Gets all error messages in the exception.

Declaration

public virtual IList<ErrorMessage> ErrorMessageList { get; }

Property Value

Type	Description
IList<ErrorMessage>	returns list of ErrorMessage objects

LocalizedMessage

Gets the text of the first error in the exception in the default locale.

Declaration

public string LocalizedMessage { get; }

Property Value

Type	Description
string

LocalizedMessageList

Gets the text of all error messages in the exception in the default locale.

Declaration

public virtual IList<string> LocalizedMessageList { get; }

Property Value

Type	Description
IList<string>	returns list of string containing the localized text all contained error messages

Message

Gets the text of the first error in the exception.

Declaration

public override string Message { get; }

Property Value

Type	Description
string	returns error text

Overrides

Exception.Message

MessageList

Gets the text of all error messages in the exception.

Declaration

public virtual IList<string> MessageList { get; }

Property Value

Type	Description
IList<string>	returns list of string containing the text all contained error messages

Methods

AppendMessage(ErrorMessage)

Append an error message to the list of errors in the exception.

Declaration

public virtual void AppendMessage(ErrorMessage mesg)

Parameters

Type	Name	Description
ErrorMessage	mesg	error message

AppendMessage(string)

Append an error message string to the list of error descriptions in this exception.

Declaration

public virtual void AppendMessage(string mesg)

Parameters

Type	Name	Description
string	mesg	generic message string

Remarks

Append an error message string to the list of error descriptions in this exception. The messages added will use ErrorMessage.USER_GENERIC as their integer error identifier.

AppendMessage(string, string)

Append an error message string to the list of error descriptions in this exception.

Declaration

public virtual void AppendMessage(string mesg, string localizedMesg)

Parameters

Type	Name	Description
string	mesg	generic message string
string	localizedMesg	localized message string

Remarks

Append an error message string to the list of error descriptions in this exception. The messages added will use ErrorMessage.USER_GENERIC as their integer error identifier.

GetObjectData(SerializationInfo, StreamingContext)

sets the SerializationInfo with information about the ApptrieveException.

Declaration

[SecurityPermission(SecurityAction.Demand, SerializationFormatter = true)]
public override void GetObjectData(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
SerializationInfo	info	The SerializationInfo that holds the serialized object data about the exception being thrown
StreamingContext	context	The StreamingContext that contains contextual information about the source or destination.

Overrides

Exception.GetObjectData(SerializationInfo, StreamingContext)

Implements

ISerializable

_Exception