PxHelpUrlRoot()

Specify a partial URL for help information

Synopsis:

#include <photon/PxHelp.h>

void PxHelpUrlRoot( char *url );

Description:

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

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

Examples:

See PxHelpUrl().

Classification:

Photon

See also:

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

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