PtHelpTopicTree()

Load a new help topic tree

Synopsis:

int PtHelpTopicTree( char *file );

Library:

ph

Description:

PtHelpTopicTree() 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 "Creating topic files" in the Helpviewer documentation in the QNX 6 Utilities Reference.

PtHelpTopicTree() 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.

PtHelpTopicTree() returns immediately, before the topic tree has been displayed.

Examples:

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

Classification:

Photon

See also:

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

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

helpviewer in the QNX 6 Utilities Reference.