IScriptError Class Reference

#include <IScriptError.h>

Inheritance diagram for IScriptError:

Public Types
enum	{ kDefaultIID = IID_ISCRIPTERROR }

Public Member Functions
virtual void	SetErrorCode (ErrorCode err)=0
virtual void	SetErrorCode (ErrorCode err, const PMString &errorString)=0
virtual ErrorCode	GetErrorCode () const =0
virtual PMString	GetErrorString () const =0
virtual void	CopyErrorInfoInto (IScriptError *target) const =0
virtual void	Reset ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Used to pass error info related to a scripting request from the script request handler back to the client (

See Also

IScriptRequestHandler). This interface should not be used by script providers (

ScriptReturnData instead).

Member Function Documentation

virtual void IScriptError::CopyErrorInfoInto ( IScriptError *  target ) const

pure virtual

Copy error information into another IScriptError

Parameters

target

is the IScriptError to which to copy our error info

virtual ErrorCode IScriptError::GetErrorCode ( ) const

pure virtual

Returns

the error code

virtual PMString IScriptError::GetErrorString ( ) const

pure virtual

Retrieve the error string. Looks it up using error string services if none has been set explicitly.

Returns

the error string

virtual void IScriptError::Reset ( )

pure virtual

Clear the error info

virtual void IScriptError::SetErrorCode ( ErrorCode  err )

pure virtual

Set the error code (assumes default error string)

Parameters

err	is the error code

virtual void IScriptError::SetErrorCode ( ErrorCode  err, const PMString &  errorString  )

pure virtual

Set the error code with an explicit error string

Parameters

err	is the error code
errorString	is the error string