Inheritance diagram for IScriptFileLocations:

Public Types
enum	{ kDefaultIID = IID_ISCRIPTFILELOCATIONS }

Public Member Functions
virtual int32	GetNumberOfScriptLocations () const =0

virtual PMString	GetNthScriptLocationName (int32 n) const =0

virtual IDFile	GetNthScriptLocation (int32 n, bool16 resolveAlias) const =0

virtual IDFile	GetScriptLocationByName (const PMString &name, bool16 resolveAlias) const =0

virtual void	AddOrReplaceScriptLocationByName (const PMString &name, const IDFile &location)=0

virtual void	RemoveScriptLocationByName (const PMString &name)=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

A utility class to access locations for scripts.

Member Function Documentation

virtual void IScriptFileLocations::AddOrReplaceScriptLocationByName	(	const PMString &	name,
		const IDFile &	location
	)

pure virtual

Add a scripts folder location. If one already exists with the same name, it is updated to the new location.

Parameters

name	is the name of the location
location	is the folder, which may or may not correspond to an actual folder on disk

virtual IDFile IScriptFileLocations::GetNthScriptLocation	(	int32	n,
		bool16	resolveAlias
	)		const

pure virtual

Retrieve the nth scripts folder location

Parameters

n	is the index of the desired location
resolveAlias	if true and the location is an alias, resolves the alias

Returns: the nth location, which may or may not correspond to an actual folder on disk

virtual PMString IScriptFileLocations::GetNthScriptLocationName ( int32 n ) const

pure virtual

Retrieve the name of the nth scripts folder location

Parameters

n	is the index of the desired location

virtual int32 IScriptFileLocations::GetNumberOfScriptLocations ( ) const

pure virtual

Retrieve the number of scripts folder locations

virtual IDFile IScriptFileLocations::GetScriptLocationByName	(	const PMString &	name,
		bool16	resolveAlias
	)		const

pure virtual

Retrieve a scripts folder location by name

Parameters

name	is the name of the desired location
resolveAlias	if true and the location is an alias, resolves the alias

Returns: the location with the specified name, which may or may not correspond to an actual folder on disk, or an empty IDFile if no match is found

virtual void IScriptFileLocations::RemoveScriptLocationByName ( const PMString & name )

pure virtual

Remove a scripts folder location.

Parameters

name	is the name of the location