[Previous] [Contents] [Index] [Next]

PxHelpTopicTree()

Load a new help topic tree

Synopsis:

#include <photon/PxHelp.h>

int PxHelpTopicTree( char *file );

Description:

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.

Returns:

0 on success, or -1 if the Helpviewer couldn't be found or spawned.


Note: PxHelpTopicTree() returns immediately, before the topic tree has been displayed.

Examples:

PxHelpTopicTree( "/usr/help/product/photon.toc" );

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PxHelpQuit(), PxHelpSearch(), PxHelpTopic(), PxHelpTopicRoot(), PxHelpUrl(), PxHelpUrlRoot()

Context-Sensitive Help chapter of the Photon Programmer's Guide


[Previous] [Contents] [Index] [Next]