PxHelpTopicRoot()

Specify the root of help topic paths

Synopsis:

#include <photon/PxHelp.h>

void PxHelpTopicRoot( char *topic );

Description:

PxHelpTopicRoot() lets you specify a partial root topic path that's prefixed to any relative topic paths in subsequent PxHelpTopic() calls. (Any path that doesn't start with a / is considered relative.)

Note:

PxHelpTopicRoot() doesn't copy the topic root. Don't free the string until you've finished using the root topic path.

Examples:

See PxHelpTopic().

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No

See also:

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

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