PtHelpTopicRoot()

Specify the root of help topic paths

Synopsis:

void PtHelpTopicRoot( char *topic );

Library:

ph

Description:

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

Note:

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

Examples:

See PtHelpTopic().

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No

See also:

PtHelpQuit(), PtHelpSearch(), PtHelpTopic(), PtHelpTopicTree(), PtHelpUrl(), PtHelpUrlRoot()

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

helpviewer in the QNX Neutrino Utilities Reference.