Load a new help topic tree
#include <photon/PxHelp.h> int PxHelpTopicTree( char *file );
PxHelpTopicTree() tells the Helpviewer to load a new topic tree. The argument must be a top-level topic file with the .toc extension. The format of the topic file is defined in the "Creating topic files" section of the Helpviewer documentation in the Photon Installation & Configuration guide.
PxHelpTopicTree() spawns the Helpviewer if it isn't running, or sends a message to the Helpviewer if it is.
0 on success, or -1 if the Helpviewer couldn't be found or spawned.
PxHelpTopicTree() returns immediately, before the topic tree has been displayed. |
PxHelpTopicTree( "/usr/help/product/photon.toc" );
Photon
Safety: | |
---|---|
Interrupt handler | No |
Signal handler | No |
Thread | No |
PxHelpQuit(), PxHelpSearch(), PxHelpTopic(), PxHelpTopicRoot(), PxHelpUrl(), PxHelpUrlRoot()
Context-Sensitive Help chapter of the Photon Programmer's Guide