PxHelpSearch()

Search the help information

Synopsis:

#include <photon/PxHelp.h>

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

Description:

Use PxHelpSearch() to search for a string in the online help information. The arguments are similar to the fields in the Helpviewer's Search pane, and are as follows:

string

The string you're looking for.

mode

One of the following:

• HELP_SEARCH_MODE_TITLE-search for string in the titles of all the help topics in the given scope.
• HELP_SEARCH_MODE_TEXT-search the text of all the help topics in the current scope.
• HELP_SEARCH_MODE_DISPLAYED-search the text of the displayed topic only.

scope

One of the following:

• HELP_SEARCH_SCOPE_ALL-search for the text in all the online help information.
• HELP_SEARCH_SCOPE_SELECTED-search for text in the selected topic only (for example, in a single book or bookset).

method

One of the following:

• HELP_SEARCH_METHOD_EXACT-search for an exact match (including case). For example, if you're searching topic titles for Help, match a title Help, but not Help files.
• HELP_SEARCH_METHOD_WORD-search for the string as a distinct word or words, ignoring case. For example, if you're searching for Help, match Help and help files but not Helpviewer.
• HELP_SEARCH_METHOD_SUBSTRING-search for the string as distinct words or as substrings, ignoring case. For example, if you're searching for Help, match Help, help files, and Helpviewer.

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

PxHelpSearch() returns immediately, before the search is complete.

Examples:

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

Classification:

Photon

See also:

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

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