CErrorStringService Class Reference

#include <CErrorStringService.h>

Inheritance diagram for CErrorStringService:

Public Member Functions
	CErrorStringService (IPMUnknown *boss, PluginID pluginPrefix, RsrcID errorStringTableRsrcID)
virtual bool16	HasUserErrorString (ErrorCode errCode, IPMUnknown *errInfo) const
virtual PMString	GetUserErrorString (ErrorCode errCode, IPMUnknown *errInfo) const
Public Member Functions inherited from CPMUnknown< IErrorStringService >
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

Protected Attributes
PluginID	fPluginID
RsrcID	fErrorStringTableRsrcID
Protected Attributes inherited from CPMUnknown< IErrorStringService >
HelperInterface	fHelperInterface

Additional Inherited Members
Public Types inherited from IErrorStringService
enum	{ kDefaultIID = IID_IERRORSTRINGSERVICE }
Protected Member Functions inherited from CPMUnknown< IErrorStringService >
	CPMUnknown (IPMUnknown *boss)

Detailed Description

Base class for implementing IErrorStringService.

Member Function Documentation

virtual PMString CErrorStringService::GetUserErrorString ( ErrorCode  errCode, IPMUnknown *  errInfo  ) const

virtual

Return the string associated with the error code. If there isn't one return an empty string.

Parameters

errCode	the error code we're looking up
errInfo	whatever errInfo is currently in the error state

Returns

PMString the user string for errCode, kFalse otherwise

Implements IErrorStringService.

virtual bool16 CErrorStringService::HasUserErrorString ( ErrorCode  errCode, IPMUnknown *  errInfo  ) const

virtual

See if the service provider has a string for errCode. When searching for an error string, the application may iterate over all the services asking for a string. A quick check to see if it is even your prefix is advised. It could be that it is your error, yet you don't have a string for it, then return kFalse.

Parameters

errCode	the error code we're looking up
errInfo	whatever errInfo is currently in the error state

Returns

kTrue if the service supplies a string for errCode, kFalse otherwise

Implements IErrorStringService.