IXMLServicesError Class Reference

#include <IXMLServicesError.h>

Inheritance diagram for IXMLServicesError:

Public Types
enum	{ kDefaultIID = IID_IXMLSERVICESERROR }

Public Member Functions
virtual void	SetErrorCode (ErrorCode errCode)=0
virtual void	SetErrorTag (const PMString &errorTag)=0
virtual ErrorCode	GetErrorCode () const =0
virtual PMString	GetErrorTag () const =0
virtual void	SignalAbort ()=0
virtual void	ClearAbort ()=0
virtual bool16	ShouldAbort () const =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

Class responsible storing the error state of an XML parse or transformation.

Member Function Documentation

virtual void IXMLServicesError::ClearAbort ( )

pure virtual

Resets the abort state of the parser or transformer.

virtual ErrorCode IXMLServicesError::GetErrorCode ( ) const

pure virtual

Accessor for the error code associated with given parse

Returns

ErrorCode specifying the error condition

virtual PMString IXMLServicesError::GetErrorTag ( ) const

pure virtual

Accessor for error tag.

Returns

PMString containing the error tag

virtual void IXMLServicesError::SetErrorCode ( ErrorCode  errCode )

pure virtual

Mutator for the error code associated with given parse. Look in XMLID.h for a list of these below "Error ID". The AXE XML parser returns a list of potential errors which get mapped to errors in the InDesign world.

Setting an error code that's not kSuccess will cause the parser to abort. Call ClearAbort() is you don't want to abort the parsing.

Parameters

errCode

virtual void IXMLServicesError::SetErrorTag ( const PMString &  errorTag )

pure virtual

Mutator for the error tag. If a error should occur while parsing the file the content handler should set the error code and return. ParseStream will check for an error condition between each parseable element and signal an error if one occurs. The error tag is the tag of the element being parsed when the error occurred.

Parameters

errorTag

new value to set

virtual bool16 IXMLServicesError::ShouldAbort ( ) const

pure virtual

Indicates that an abort has been signaled.

virtual void IXMLServicesError::SignalAbort ( )

pure virtual

Signals the parser or the transformer to abort on the next element.