Gamma/Photon : Using Gamma™ with the Photon microGUI®, Version 1.1
	Extended Functions

`PxHelpTopicRoot`

PxHelpTopicRoot — sets the helpviewer topic root.

Syntax

PxHelpTopicRoot (topic_root)

Arguments

topic_root: A string containing a path that will make the new topic root. Topic roots are relative from the /usr/help/product directory.

Returns

This function always returns t.

Description

This function sets the helpviewer topic root. The topic root is the current path in the topic tree. Changing the topic root allows the developer to issue PxHelpTopic commands with a short argument rather than having to maintain a path-like string.

Example

Gamma> PxHelpTopicRoot("/Gamma/Photon in Gamma/Widget Reference");
t
Gamma> PxHelpTopic("re-ptarc.html");
t <The PtArc helpviewer page is displayed.>

See Also

PxHelpQuit, PxHelpTopic, PxHelpTopicTree, PxHelpUrl, PxHelpUrlRoot

and in Photon documentation: PxHelpTopicRoot.


PxHelpTopic		PxHelpTopicTree

Copyright © 1995-2010 by Cogent Real-Time Systems, Inc. All rights reserved.