IPathConfigMgrEx Class Reference

#include <IPathConfigMgr.h>

Class Description

Provides extended access to application path configuration functionality.

To access the single IPathConfigMgrEx instance, call the static function IPathConfigMgrEx::GetPathConfigMgr().

Inheritance diagram for IPathConfigMgrEx:

Public Member Functions
virtual void	GetProjectDirectoryCreateFilters (Tab< int > &filterIDs)=0
	Returns a Tab of the IDs in the persistent internal filter table. More...
virtual MAX_DEPRECATED const MCHAR *	GetExchangeStorePlugInInstallPath (const MSTR &) const MAX_SEALED
	Returns the installation path of a plugin package loaded via Plug-in Package Manager based on the upgrade code. More...
Public Member Functions inherited from IPathConfigMgr
virtual bool	LoadPathConfiguration (const MCHAR *filename)=0
	Loads a path configuration file. More...
virtual bool	MergePathConfiguration (const MCHAR *filename)=0
	Merges a path configuration file. More...
virtual bool	SavePathConfiguration (const MCHAR *filename)=0
	Saves out the current path configuration to the specified file. More...
virtual const MCHAR *	GetDir (int which) const =0
	Returns the default directory for the specified ID. More...
virtual bool	SetDir (int which, const MCHAR *dir)=0
	Sets the default directory. More...
virtual int	GetPlugInEntryCount () const =0
	Returns the number of plugin path entries in PLUGIN.INI. More...
virtual const MCHAR *	GetPlugInDesc (int i) const =0
	Returns the description string for the given entry number. More...
virtual const MCHAR *	GetPlugInDir (int i) const =0
	Returns the directory string for the given entry number. More...
virtual int	GetAssetDirCount (MaxSDK::AssetManagement::AssetType assetType) const =0
	Returns the number of assetType directories in path. More...
virtual const MCHAR *	GetAssetDir (int i, MaxSDK::AssetManagement::AssetType assetType) const =0
	Returns the ith assetType directory in path. More...
virtual bool	AddAssetDir (const MCHAR *dir, MaxSDK::AssetManagement::AssetType assetType)=0
	Adds an assetType path to the list. More...
virtual bool	AddAssetDir (const MCHAR *dir, MaxSDK::AssetManagement::AssetType assetType, int update)=0
	Adds an assetType path to the list. More...
virtual bool	DeleteAssetDir (int i, MaxSDK::AssetManagement::AssetType assetType, int update)=0
	Deletes an assetType path. More...
virtual bool	AddSessionAssetDir (const MCHAR *dir, MaxSDK::AssetManagement::AssetType assetType, int update)=0
	Adds a session path. More...
virtual int	GetSessionAssetDirCount (MaxSDK::AssetManagement::AssetType assetType) const =0
	Returns the number of assetType session directories in path. More...
virtual const MCHAR *	GetSessionAssetDir (int i, MaxSDK::AssetManagement::AssetType assetType) const =0
	Returns the assetType session directory in path. More...
virtual bool	DeleteSessionAssetDir (int i, MaxSDK::AssetManagement::AssetType assetType, int update)=0
	Deletes a session path. More...
virtual int	GetCurAssetDirCount (MaxSDK::AssetManagement::AssetType assetType) const =0
	Gets the combined total of session and permanent paths. More...
virtual const MCHAR *	GetCurAssetDir (int i, MaxSDK::AssetManagement::AssetType assetType) const =0
	Gets the ith assetType directory. More...
virtual void	UpdateAssetSection (MaxSDK::AssetManagement::AssetType assetType)=0
	Forces an update on the application. More...
virtual MSTR	GetMAXIniFile () const =0
	Returns the name of the .ini file used by max. More...
virtual bool	GetResolveUNC () const =0
	Returns the Preferences –> Files [Convert networked file paths to UNC] property. More...
virtual void	SetResolveUNC (bool aFlag)=0
	Sets the Preferences –> Files [Convert networked file paths to UNC] property. More...
virtual bool	GetResolveToRelative () const =0
	Returns the Preferences –> Files [Convert local file paths to Relative] property If this method returns true, then paths selected as assets will automatically be converted to their relative equivalents, made relative to the current Project Folder setting. More...
virtual void	SetResolveToRelative (bool aFlag)=0
	Sets the Preferences –> Files [Convert local file paths to Relative] property If this flag is set to true, then paths selected as assets will automatically be converted to their relative equivalents, made relative to the current Project Folder setting. More...
virtual void	AppendSlash (MCHAR *path) const =0
	This function appends a slash character to the end of the path passed unless one already exists. More...
virtual void	RemoveSlash (MCHAR *path) const =0
	This function removes the slash character from the end of the path passed if present. More...
virtual void	AppendSlash (MSTR &path) const =0
	This function appends a slash character to the end of the path passed unless one already exists. More...
virtual void	RemoveSlash (MSTR &path) const =0
	This function removes the slash character from the end of the path passed if present. More...
virtual bool	IsUsingProfileDirectories () const =0
	Checks whether the application is configured to use User Profile directories. More...
virtual bool	IsUsingRoamingProfiles () const =0
	Checks whether the application is configured to use roaming profiles. More...
virtual const MaxSDK::Util::Path &	GetCurrentProjectFolder () const =0
	Returns the current Project Folder folder. More...
virtual bool	SetCurrentProjectFolder (const MaxSDK::Util::Path &aDirectory)=0
	Sets the current Project Folder folder. More...
virtual bool	SetSessionProjectFolder (const MaxSDK::Util::Path &aDirectory)=0
	Sets a Project Folder which will be used for this application session only. More...
virtual bool	DoProjectSetupSteps () const =0
	Initiates the steps to choose and setup a max project. More...
virtual bool	DoProjectSetupStepsUsingDirectory (const MaxSDK::Util::Path &aDirectory) const =0
	Initiates the steps to choose and setup a max project without prompting the user. More...
virtual bool	IsProjectFolder (const MaxSDK::Util::Path &aDirectoryToCheck) const =0
	Will check for the existence of a project in a folder. More...
virtual MaxSDK::Util::Path	GetProjectFolderPath (const MaxSDK::Util::Path &aProjectRoot) const =0
	Will return the fully-qualified path of the project file, given the root folder of an existing project. More...
virtual MaxSDK::Util::Path	GetCurrentProjectFolderPath () const =0
	Returns the file path of the current project file, if it exists. More...
virtual void	MakePathRelativeToProjectFolder (MaxSDK::Util::Path &aPath) const =0
	Converts an absolute path into a path that is relative to the current Project Folder. More...
virtual bool	CreateDirectoryHierarchy (const MaxSDK::Util::Path &aPath) const =0
	Creates a hierarchy of directories. More...
virtual bool	DoesFileExist (const MaxSDK::Util::Path &aPath) const =0
	Checks if a file or directory exists in the location pointed to by the absolute path parameter, considering IMissingPathCache. More...
virtual void	NormalizePathAccordingToSettings (MaxSDK::Util::Path &aPath) const =0
	Will Normalize this absolute path according to the current application settings. More...
virtual void	RecordInputAsset (const MaxSDK::AssetManagement::AssetUser &originalPath, AssetEnumCallback &nameEnum, DWORD vflags) const =0
	Searches for the given path and records the path in the NameEnum according to its ability to resolve the path and if missing only is set in the flags. More...
virtual void	RecordOutputAsset (const MaxSDK::AssetManagement::AssetUser &originalAsset, AssetEnumCallback &nameEnum, DWORD vflags) const =0
	Converts the given path to absolute and records the path in the AssetEnum according to its ability to resolve the path and if missing only is set in the flags. More...
virtual int	GetProjectSubDirectoryCount () const =0
	Gets a count of the number of Project directories. More...
virtual const MCHAR *	GetProjectSubDirectory (int aIndex) const =0
	Returns a project directory according to an index, not an ID This method will return a Project directory by index, rather than by ID. More...
virtual void	AddProjectDirectoryCreateFilter (int aID)=0
	Adds an ID to a persistent internal filter table. More...
virtual void	RemoveAllProjectDirectoryCreateFilters ()=0
	Removes all IDs from a persistent internal filter table. More...
virtual void	RemoveProjectDirectoryCreateFilter (int aID)=0
	Removes an ID from a persistent internal filter table. More...
Public Member Functions inherited from FPInterfaceDesc
CoreExport	FPInterfaceDesc ()
CoreExport	FPInterfaceDesc (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, ULONG flag,...)
CoreExport	~FPInterfaceDesc ()
virtual void	Init ()
LifetimeType	LifetimeControl ()
virtual BaseInterface *	GetInterface (Interface_ID id)
CoreExport void	LoadDescriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *pCD, ULONG flag,...)
CoreExport void	AppendFunction (int id,...)
	Add a new function to this interface descriptor. More...
CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor. More...
CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor. More...
CoreExport void	SetClassDesc (ClassDesc *i_cd)
CoreExport va_list	check_fn (va_list ap, int id)
CoreExport va_list	scan_fn (va_list ap, int id, int index)
CoreExport va_list	check_prop (va_list ap, int id)
CoreExport va_list	scan_prop (va_list ap, int id, int index)
CoreExport va_list	check_enum (va_list ap, EnumID id)
CoreExport va_list	scan_enum (va_list ap, EnumID id, int index)
FPInterfaceDesc *	GetDesc ()
Interface_ID	GetID ()
CoreExport FPFunctionDef *	GetFnDef (FunctionID fid)
ActionTable *	GetActionTable ()
CoreExport void	EnableActions (BOOL onOff)
virtual CoreExport HINSTANCE	HInstance ()
virtual CoreExport const MCHAR *	GetRsrcString (StringResID id)
Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPParams *params)
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
virtual CoreExport FunctionID	FindFn (const MCHAR *name)
virtual CoreExport BOOL	IsEnabled (FunctionID actionID)
virtual CoreExport BOOL	IsChecked (FunctionID actionID)
virtual CoreExport BOOL	IsVisible (FunctionID actionID)
virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)
virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)
virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...
virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=NULL)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

Static Public Member Functions
static CoreExport IPathConfigMgrEx *	GetPathConfigMgr ()
	Returns the single instance of this manager. More...
Static Public Member Functions inherited from IPathConfigMgr
static CoreExport IPathConfigMgr *	GetPathConfigMgr ()
	Returns the single instance of this manager. More...
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Additional Inherited Members
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }
Public Attributes inherited from FPInterfaceDesc
Interface_ID	ID
MSTR	internal_name
StringResID	description
ClassDesc *	cd
USHORT	flags
Tab< FPFunctionDef * >	functions
Tab< FPPropDef * >	props
Tab< FPEnum * >	enumerations
MSPluginClass *	pc
Rollout *	rollout
ActionTable *	action_table
Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface
Protected Member Functions inherited from FPInterfaceDesc
CoreExport void	load_descriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, USHORT flag, va_list ap)
Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Member Function Documentation

virtual void GetProjectDirectoryCreateFilters ( Tab< int > &  filterIDs )

pure virtual

Returns a Tab of the IDs in the persistent internal filter table.

Gets the IDs from the persistent internal filter table.

Parameters

[out]

filterIDs

Tab containing the IDs from the persistent internal filter table.

virtual MAX_DEPRECATED const MCHAR* GetExchangeStorePlugInInstallPath ( const MSTR &  ) const

inlinevirtual

Returns the installation path of a plugin package loaded via Plug-in Package Manager based on the upgrade code.

Deprecated:

Use MaxSDK::PluginPackageManager::GetInstance()->GetPackageInstallPathByUpgradeCode(const MCHAR* upgradeCode).

{ return nullptr; }

static CoreExport IPathConfigMgrEx* GetPathConfigMgr ( )

static

Returns the single instance of this manager.

Gets the single instance of this class.

Returns

The single instance of this class.