Caution: This version of this document is no longer maintained. For the latest documentation, see http://www.qnx.com/developers/docs.

PtHelpUrlRoot()

Specify a partial URL for help information

Synopsis:

void PtHelpUrlRoot( char *url );

Library:

ph

Description:

PtHelpUrlRoot() lets you specify a partial root URL that's prefixed to any relative URLs in subsequent PtHelpUrl() calls. (A relative URL is one that doesn't start with a /.)


Note: PtHelpUrlRoot() doesn't copy the given URL. Don't free the string until you've finished using the root URL.

Examples:

See PtHelpUrl().

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

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

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

helpviewer in the QNX Neutrino Utilities Reference.