_SnpRunnerInspectPathInfo Class Reference

Inheritance diagram for _SnpRunnerInspectPathInfo:

Public Member Functions
	_SnpRunnerInspectPathInfo ()
virtual	~_SnpRunnerInspectPathInfo ()
bool16	CanRun (ISnpRunnableContext *runnableContext)
ErrorCode	Run (ISnpRunnableContext *runnableContext)
bool16	CanLoad () const
virtual ISnipRunSuite::eSnpRunContextType	GetContext (void)
Public Member Functions inherited from SnpRunnable
	SnpRunnable (ConstCString name)
virtual	~SnpRunnable ()
virtual ConstCString	GetName () const
virtual ConstCString	GetDescription () const
virtual ConstCString	GetPreconditions () const
virtual ConstCString	GetCategories () const
virtual ErrorCode	RunUnitTest (ISnpRunnableContext *runnableContext)
virtual ErrorCode	SetupContext (ISnpRunnableContext *runnableContext)

Additional Inherited Members
Protected Member Functions inherited from SnpRunnable
virtual void	SetDescription (ConstCString description)
virtual void	SetPreconditions (ConstCString preconditions)
virtual void	SetCategories (ConstCString categories)

Detailed Description

Makes the snippet SnpInspectPathInfo available to the SnippetRunner framework.

Constructor & Destructor Documentation

_SnpRunnerInspectPathInfo::_SnpRunnerInspectPathInfo

(

)

Constructor.

_SnpRunnerInspectPathInfo::~_SnpRunnerInspectPathInfo ( )

virtual

Destructor

Member Function Documentation

bool16 _SnpRunnerInspectPathInfo::CanLoad ( void  ) const

virtual

Don't present this snippet in the framework's UI if the product we are running under is InCopy.

Returns

kFalse if the host product is InCopy, kTrue otherwise.

Reimplemented from SnpRunnable.

bool16 _SnpRunnerInspectPathInfo::CanRun ( ISnpRunnableContext *  runnableContext )

virtual

Return kTrue if the snippet can run.

Parameters

runnableContext

see ISnpRunnableContext for documentation.

Returns

kTrue if a document is open, kFalse otherwise

Implements SnpRunnable.

virtual ISnipRunSuite::eSnpRunContextType _SnpRunnerInspectPathInfo::GetContext ( void  )

inlinevirtual

get the snippet context

Returns

eSnpRunContextType for this snippet

Implements SnpRunnable.

ErrorCode _SnpRunnerInspectPathInfo::Run ( ISnpRunnableContext *  runnableContext )

virtual

Run the snippet.

Parameters

runnableContext

see ISnpRunnableContext for documentation.

Returns

kSuccess on success, other ErrorCode otherwise.

Implements SnpRunnable.