Warning: main(/www/www/htdocs/style/globals.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/pt/pthelpsearch.html on line 1
Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/globals.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/pt/pthelpsearch.html on line 1
Warning: main(/www/www/htdocs/style/header.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/pt/pthelpsearch.html on line 8
Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/header.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/pt/pthelpsearch.html on line 8
Search the help information
int PtHelpSearch( char *string,
int mode,
int scope,
int method );
- 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 (excluding 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.
- HELP_SEARCH_METHOD_SUBSTRING_CASE — search for the
string as distinct words or as substrings, paying attention to the case.
For example, if you're searching for
Help, match Help and Helpviewer, but
not help files.
ph
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.
0 on success, or -1 if the Helpviewer couldn't be found or spawned.
|
PtHelpSearch() returns immediately, before the search is complete. |
PtHelpSearch( "console", HELP_SEARCH_MODE_TITLE,
HELP_SEARCH_SCOPE_ALL,
HELP_SEARCH_METHOD_SUBSTRING );
Photon
Safety: | |
Interrupt handler |
No |
Signal handler |
No |
Thread |
No |
PtHelpQuit(),
PtHelpTopic(),
PtHelpTopicRoot(),
PtHelpTopicTree(),
PtHelpUrl(),
PtHelpUrlRoot()
Context-Sensitive Help chapter
of the Photon Programmer's Guide
helpviewer
in the QNX Neutrino Utilities Reference.
Warning: main(/www/www/htdocs/style/footer.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/pt/pthelpsearch.html on line 211
Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/footer.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/pt/pthelpsearch.html on line 211