IHelpSystem Class Reference

This interface provides access to the 3ds Max Help system. More...

#include <helpsys.h>

Inheritance diagram for IHelpSystem:

Public Types
enum	ProductHelpLocationType { OnlineHelp , LocalHelp }
	Possible 3ds Max product help locations. More...
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

Public Member Functions
virtual ProductHelpLocationType	ProductHelpLocation () const =0
	Returns the current 3ds Max product help location method. More...
virtual void	SeProducttHelpLocation (ProductHelpLocationType location=OnlineHelp)=0
	Sets the product help location to be Autodesk web site or local network. Saves the value to the ini file. More...
virtual const MCHAR *	LocalProductHelpPath () const =0
	Get the current local product help path, that is used when MaxSDK::IHelpSystem::ProductHelpLocation() is OnlineHelp. More...
virtual void	SetLocalProductHelpPath (const MCHAR *path)=0
	Sets the current local help location, that is used when MaxSDK::IHelpSystem::ProductHelpLocation() is LocalHelp. Saves the value to the ini file. More...
virtual const MCHAR *	DefaultLocalProductHelpPath () const =0
	Get the default local product help path to the default local help path setting. More...
virtual bool	ShowProductHelp () const =0
	Shows the 3ds Max Product Help. The current settings are used to determine if help is displayed from an online or a local location. More...
virtual bool	ShowProductHelpForTopic (int contextId) const =0
	Shows the 3ds Max Product Help for a specific topic. The current settings are used to determine if help is displayed from an online or a local location. More...
virtual bool	ShowProductHelpForTopic (const MCHAR *topic) const =0
	Shows the 3ds Max Product Help for a specific topic provided as a string (if some help system is available). More...
virtual bool	ShowProductHelpSearch (const MCHAR *searchFor) const =0
	Shows the 3ds Max Product Help for a search term (if some help system is available). More...
virtual bool	ShowMaxscriptHelp (const MCHAR *searchFor=nullptr) const =0
	Shows the online Maxscript documentation. More...
virtual bool	ShowPythonHelp (const MCHAR *searchFor=nullptr) const =0
	Shows the online Python documentation. More...
virtual bool	OpenChmFile (const MCHAR *path, const MCHAR *indexString=nullptr) const =0
	Opens a chm file. 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...
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Static Public Member Functions
static IHelpSystem *	GetInstance ()
	Returns the IHelpSystem interface. 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 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)

Detailed Description

This interface provides access to the 3ds Max Help system.

To display help related to the product, use the MaxSDK::IHelpSystem::ShowProductHelpForTopic() function. The 3ds Max product help can either be displayed from online servers (default behavior) or from a local path. Can be use to get and set help location preferences. Maxscript help is always accessed online. This is not meant to control "Additional Help" (help for installed third-party plug-ins and add-ons).

// Set the help location to be online
MaxSDK::IHelpSystem * helpSys = MaxSDK::IHelpSystem::GetInstance();
helpSys->SeProducttHelpLocation( MaxSDK::IHelpSystem::OnlineHelp );

Member Enumeration Documentation

ProductHelpLocationType

enum ProductHelpLocationType

Possible 3ds Max product help locations.

Enumerator
OnlineHelp	Help is displayed from Autodesk's servers. Actual online location can not be changed. Help is displayed from a local path. The actual path can be controlled using MaxSDK::IHelpSystem::SetLocalProductHelpPath().
LocalHelp

                                 {
        OnlineHelp
        , LocalHelp
    };

Member Function Documentation

ProductHelpLocation()

virtual ProductHelpLocationType ProductHelpLocation ( ) const

pure virtual

Returns the current 3ds Max product help location method.

SeProducttHelpLocation()

virtual void SeProducttHelpLocation ( ProductHelpLocationType  location = OnlineHelp )

pure virtual

Sets the product help location to be Autodesk web site or local network. Saves the value to the ini file.

LocalProductHelpPath()

virtual const MCHAR* LocalProductHelpPath ( ) const

pure virtual

Get the current local product help path, that is used when MaxSDK::IHelpSystem::ProductHelpLocation() is OnlineHelp.

SetLocalProductHelpPath()

virtual void SetLocalProductHelpPath ( const MCHAR *  path )

pure virtual

Sets the current local help location, that is used when MaxSDK::IHelpSystem::ProductHelpLocation() is LocalHelp. Saves the value to the ini file.

DefaultLocalProductHelpPath()

virtual const MCHAR* DefaultLocalProductHelpPath ( ) const

pure virtual

Get the default local product help path to the default local help path setting.

ShowProductHelp()

virtual bool ShowProductHelp ( ) const

pure virtual

Shows the 3ds Max Product Help. The current settings are used to determine if help is displayed from an online or a local location.

ShowProductHelpForTopic() [1/2]

virtual bool ShowProductHelpForTopic ( int  contextId ) const

pure virtual

Shows the 3ds Max Product Help for a specific topic. The current settings are used to determine if help is displayed from an online or a local location.

ShowProductHelpForTopic() [2/2]

virtual bool ShowProductHelpForTopic ( const MCHAR *  topic ) const

pure virtual

Shows the 3ds Max Product Help for a specific topic provided as a string (if some help system is available).

ShowProductHelpSearch()

virtual bool ShowProductHelpSearch ( const MCHAR *  searchFor ) const

pure virtual

Shows the 3ds Max Product Help for a search term (if some help system is available).

ShowMaxscriptHelp()

virtual bool ShowMaxscriptHelp ( const MCHAR *  searchFor = nullptr ) const

pure virtual

Shows the online Maxscript documentation.

ShowPythonHelp()

virtual bool ShowPythonHelp ( const MCHAR *  searchFor = nullptr ) const

pure virtual

Shows the online Python documentation.

OpenChmFile()

virtual bool OpenChmFile ( const MCHAR *  path, const MCHAR *  indexString = nullptr  ) const

pure virtual

Opens a chm file.

GetInstance()

static IHelpSystem* GetInstance ( )

inlinestatic

Returns the IHelpSystem interface.

                                       {
        return static_cast<IHelpSystem*>(GetCOREInterface(IID_IHelpSystem));
    }