#include <IINXErrorHandler.h>

Inheritance diagram for IINXErrorHandler:

Public Types
enum	{ kDefaultIID = IID_IINXERRORHANDLER }

enum	INXErrorStatus { kINXContinue = 0, kINXCancel }

Public Member Functions
virtual void	ResetINXErrorStatus ()=0

virtual IINXErrorHandler::INXErrorStatus	GetINXErrorStatus () const =0

virtual void	BeginExport (const IPMStream *stream, const IDOMElement::ElementList &roots)=0

virtual void	EndExport ()=0

virtual void	BeginImport (const IPMStream *stream)=0

virtual void	EndImport ()=0

virtual void	UnknownElement (const ScriptID &parent, const WideString &elem)=0

virtual void	UnknownProperty (const ScriptID &parent, const WideString &prop)=0

virtual void	UnresolvedReference (const WideString &selfID)=0

virtual void	ParserError (ErrorCode err, const PMString &errorStr)=0

virtual void	ScriptingError (const IScript script, const IScriptRequestData scriptRequestData, const ScriptReturnData &returnData)=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

Provides error information during INX operation for new IDML format.

3rd party developer can implement this interface to receive error infromatiom from inx core. Please see SDK sample INXErrorLogging.sdk.vcproj for detail.

Member Function Documentation

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

pure virtual

Begin export session.

Parameters

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

Implemented in SDKINXErrorHandler.

virtual void IINXErrorHandler::BeginImport ( const IPMStream * stream )

pure virtual

Begin import session.

Parameters

stream The stream import from.

Implemented in SDKINXErrorHandler.

virtual void IINXErrorHandler::EndExport ( )

pure virtual

End export session.

Implemented in SDKINXErrorHandler.

virtual void IINXErrorHandler::EndImport ( )

pure virtual

End import session.

Implemented in SDKINXErrorHandler.

virtual IINXErrorHandler::INXErrorStatus IINXErrorHandler::GetINXErrorStatus ( ) const

pure 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

Implemented in SDKINXErrorHandler.

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

pure virtual

Report parser error. Import only.

Parameters

err	The error code
errorStr	The error string

Implemented in SDKINXErrorHandler.

virtual void IINXErrorHandler::ResetINXErrorStatus ( )

pure virtual

Reset the current INX error status to kINXContinue.

Implemented in SDKINXErrorHandler.

virtual void IINXErrorHandler::ScriptingError	(	const IScript *	script,
		const IScriptRequestData *	scriptRequestData,
		const ScriptReturnData &	returnData
	)

pure virtual

Report scripting error.

Parameters

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

Following error codes are not considered as problem: kPropertyNotApplicableError, kCellStyleAttributeNotDefinedError, kTableStyleAttributeNotDefinedError, kInvalidRequestForRootStyleError, kGraphicAttrNotSupportedError, kImageInfoNotAvailableError, kObsoleteScriptingRequestError, kReadOnlyPropertyError, kGraphicAttrMixedSelectionError, kDefaultKinsokuReadOnlyError, kDefaultMojikumiReadOnlyError

Implemented in SDKINXErrorHandler.

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

pure virtual

Report an unknown element. Import only.

Parameters

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

Implemented in SDKINXErrorHandler.

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

pure virtual

Report an unknown property on known object. Import only.

Parameters

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

Implemented in SDKINXErrorHandler.

virtual void IINXErrorHandler::UnresolvedReference ( const WideString & selfID )

pure virtual

Report an un-resolved reference. Import only.

Parameters

selfID The self ID of referenced object

Implemented in SDKINXErrorHandler.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation