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 );
#include <helpsys.h>
Public Types |
|
enum | ProductHelpLocationType { OnlineHelp, LocalHelp } |
Possible 3ds Max product help locations. More... |
|
Public Member Functions |
|
virtual ProductHelpLocationType | ProductHelpLocation () const =0 |
Returns the current 3ds Max product help
location method. |
|
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. |
|
virtual const MCHAR * | LocalProductHelpPath () const =0 |
Get the current local product help path,
that is used when MaxSDK::IHelpSystem::ProductHelpLocation()
is OnlineHelp. |
|
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. |
|
virtual const MCHAR * | DefaultLocalProductHelpPath () const =0 |
Get the default local product help path to
the default local help path setting. |
|
virtual void | 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. |
|
virtual void | 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. |
|
virtual void | ShowProductHelpForTopic (const MCHAR *topic) const =0 |
Shows the product help for a specific topic
provided as a string (if some help system is available). |
|
virtual void | ShowMaxscriptHelp (const MCHAR *searchFor=NULL) const =0 |
Shows the Maxscript documentation. |
|
virtual void | OpenChmFile (const MCHAR *path) const =0 |
Opens a chm file. |
|
Static Public Member Functions |
|
static IHelpSystem * | GetInstance () |
Returns the IHelpSystem
interface. |
Possible 3ds Max product help locations.
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 };
virtual ProductHelpLocationType ProductHelpLocation | ( | ) | const [pure virtual] |
Returns the current 3ds Max product help location method.
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.
virtual const MCHAR* LocalProductHelpPath | ( | ) | const [pure virtual] |
Get the current local product help path, that is used when MaxSDK::IHelpSystem::ProductHelpLocation() is OnlineHelp.
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.
virtual const MCHAR* DefaultLocalProductHelpPath | ( | ) | const [pure virtual] |
Get the default local product help path to the default local help path setting.
virtual void 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.
virtual void 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.
virtual void ShowProductHelpForTopic | ( | const MCHAR * | topic | ) | const [pure virtual] |
Shows the product help for a specific topic provided as a string (if some help system is available).
virtual void ShowMaxscriptHelp | ( | const MCHAR * | searchFor = NULL |
) | const [pure virtual] |
Shows the Maxscript documentation.
virtual void OpenChmFile | ( | const MCHAR * | path | ) | const [pure virtual] |
Opens a chm file.
static IHelpSystem* GetInstance | ( | ) | [inline, static] |
Returns the IHelpSystem interface.
{ return static_cast<IHelpSystem*>(GetCOREInterface(IID_IHelpSystem)); }