IErrorList Class Reference

#include <IErrorList.h>

Inheritance diagram for IErrorList:

Public Types
enum	{ kDefaultIID = IID_IERRORLIST }

Public Member Functions
virtual void	AddError (const int32 iconID, const PMString &message, const UIDRef &target, const ErrorCode errCode)=0
virtual void	RemoveError (int32 whichOne)=0
virtual void	Clear ()=0
virtual int32	GetNumErrors ()=0
virtual int32	GetMaxNumErrors ()=0
virtual void	SetMaxNumErrors (int32 newMaxNumErrors)=0
virtual ErrorCode	GetErrorCode (int32 whichOne)=0
virtual int32	GetErrorLevel (int32 whichOne)=0
virtual PMString	GetErrorMessage (int32 whichOne)=0
virtual GlobalTime	GetErrorTime (int32 whichOne)=0
virtual PMString	GetErrorTimeAsString (int32 whichOne)=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

Stores errors for later display, an interface off the session (kSessionBoss).

Member Function Documentation

virtual void IErrorList::AddError ( const int32  iconID, const PMString &  message, const UIDRef &  target, const ErrorCode  errCode  )

pure virtual

Adds an error to the in-memory error capture list.

Parameters

iconID	the error "level" that would normally be put in the CAlert - one of Error, Warning, Information, Question
message	the message that would normally be put in the CAlert
target	the target of this error, the most used part is the database which is used to match errors to a specific document
errorCode	the error code (number) of the error

virtual void IErrorList::Clear ( )

pure virtual

Removes all errors from the in-memory error capture list.

virtual ErrorCode IErrorList::GetErrorCode ( int32  whichOne )

pure virtual

Returns the error code of the specified error in the list.

Parameters

whichOne

which entry in the error list

Returns

the stored error code

virtual int32 IErrorList::GetErrorLevel ( int32  whichOne )

pure virtual

Returns the error level (number) of the specified error in the list. The error level is one of Error, Warning, Information, or Question.

Parameters

whichOne

which entry in the error list

Returns

the error level

virtual PMString IErrorList::GetErrorMessage ( int32  whichOne )

pure virtual

Returns the error message of the specified error in the list.

Parameters

whichOne

which entry in the error list

Returns

the stored error message

virtual GlobalTime IErrorList::GetErrorTime ( int32  whichOne )

pure virtual

Returns the time the error occurred of the specified error in the list.

Parameters

whichOne

which entry in the error list

Returns

the stored error occurance time

virtual PMString IErrorList::GetErrorTimeAsString ( int32  whichOne )

pure virtual

Returns the time the error occurred of the specified error in the list.

Parameters

whichOne

which entry in the error list

Returns

the stored error occurance time

virtual int32 IErrorList::GetMaxNumErrors ( )

pure virtual

Returns the maximum allowed number of errors before the in-memory error capture list resets. This value is settable from the command line using "-maxerrors NNNN." If maxNumErrors is set to -1 (or any other negative number), we interpret that as no maximum.

virtual int32 IErrorList::GetNumErrors ( )

pure virtual

Returns the total number of errors from the in-memory error capture list.

virtual void IErrorList::RemoveError ( int32  whichOne )

pure virtual

Removes an error from the in-memory error capture list.

Parameters

whichOne

which entry in the error list to remove

virtual void IErrorList::SetMaxNumErrors ( int32  newMaxNumErrors )

pure virtual

Sets the maximum allowed number of errors before the in-memory error capture list resets. This value is settable from the command line using "-maxerrors NNNN." Use of this method may override what was set on the command line.