SDKINXErrorHandler Class Reference

Inheritance diagram for SDKINXErrorHandler:

Public Member Functions
	SDKINXErrorHandler (IPMUnknown *boss)
virtual void	ResetINXErrorStatus ()
virtual IINXErrorHandler::INXErrorStatus	GetINXErrorStatus () const
virtual void	BeginExport (const IPMStream *stream, const IDOMElement::ElementList &roots)
virtual void	EndExport ()
virtual void	BeginImport (const IPMStream *stream)
virtual void	EndImport ()
virtual void	UnknownElement (const ScriptID &parent, const WideString &elem)
virtual void	UnknownProperty (const ScriptID &parent, const WideString &prop)
virtual void	UnresolvedReference (const WideString &selfID)
virtual void	ParserError (ErrorCode err, const PMString &errorStr)
virtual void	ScriptingError (const IScript *script, const IScriptRequestData *eventData, const ScriptReturnData &returnData)
Public Member Functions inherited from CPMUnknown< IINXErrorHandler >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete

Additional Inherited Members
Public Types inherited from IINXErrorHandler
enum	{ kDefaultIID = IID_IINXERRORHANDLER }
enum	INXErrorStatus { kINXContinue = 0, kINXCancel }
Protected Member Functions inherited from CPMUnknown< IINXErrorHandler >
	CPMUnknown (IPMUnknown *boss)
Protected Attributes inherited from CPMUnknown< IINXErrorHandler >
HelperInterface	fHelperInterface

Member Function Documentation

void SDKINXErrorHandler::BeginExport ( const IPMStream *  stream, const IDOMElement::ElementList &  roots  )

virtual

Begin export session.

Parameters

stream	The stream export to.
roots	The list of element to be exported.

Implements IINXErrorHandler.

void SDKINXErrorHandler::BeginImport ( const IPMStream *  stream )

virtual

Begin import session.

Parameters

stream

The stream import from.

Implements IINXErrorHandler.

void SDKINXErrorHandler::EndExport ( )

virtual

End export session.

Implements IINXErrorHandler.

void SDKINXErrorHandler::EndImport ( )

virtual

End import session.

Implements IINXErrorHandler.

IINXErrorHandler::INXErrorStatus SDKINXErrorHandler::GetINXErrorStatus ( ) const

virtual

Get the current INX error status. Set to kINXCancel in one of the callbacks on this implementation to abort further processing.

Returns

the current status

Implements IINXErrorHandler.

void SDKINXErrorHandler::ParserError ( ErrorCode  err, const PMString &  errorStr  )

virtual

Report parser error. Import only.

Parameters

err	The error code
errorStr	The error string

Implements IINXErrorHandler.

void SDKINXErrorHandler::ResetINXErrorStatus ( )

virtual

Reset the current INX error status to kINXContinue.

Implements IINXErrorHandler.

void SDKINXErrorHandler::ScriptingError ( const IScript *  script, const IScriptRequestData *  eventData, const ScriptReturnData &  returnData  )

virtual

Report scripting error.

Parameters

script	The object on which the scripting request was invoked
eventData	The event data for the scripting request
returnData	The return data for the scripting request that failed

if( IsKnownPropertyError(errorCode) ) return;

Implements IINXErrorHandler.

void SDKINXErrorHandler::UnknownElement ( const ScriptID &  parent, const WideString &  elem  )

virtual

Report an unknown element. Import only.

Parameters

parent	The script id of unknown element.
elem	The name of unknown element

Implements IINXErrorHandler.

void SDKINXErrorHandler::UnknownProperty ( const ScriptID &  parent, const WideString &  prop  )

virtual

Report an unknown property on known object. Import only.

Parameters

parent	The script id of known object.
prop	The name of unknown property

Implements IINXErrorHandler.

void SDKINXErrorHandler::UnresolvedReference ( const WideString &  selfID )

virtual

Report an un-resolved reference. Import only. This happens when the value of an attribute refers to an object, but the object is not included in the document.

Parameters

selfID

The self ID of referenced object

Implements IINXErrorHandler.