PtHelpSearch()

Search the help information

Synopsis:

int PtHelpSearch( char *string,
                  int mode,
                  int scope,
                  int method );

Arguments:

string
The string you're looking for.
mode
One of the following:
scope
One of the following:
method
One of the following:

Library:

ph

Description:

Use PtHelpSearch() to search for a string in the online help information. PtHelpSearch() 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.


Note: PtHelpSearch() returns immediately, before the search is complete.

Examples:

PtHelpSearch( "console", HELP_SEARCH_MODE_TITLE,
              HELP_SEARCH_SCOPE_ALL,
              HELP_SEARCH_METHOD_SUBSTRING );

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

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

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

helpviewer in the QNX Neutrino Utilities Reference.