Click or drag to resize

HelpDisplay.Show Method

X#
Instruct the help system to provide the help topic associated with a given keyword.

Namespace:  VO
Assembly:  VOGUIClasses (in VOGUIClasses.dll) Version: 2.21
Syntax
Copy
 VIRTUAL METHOD Show(
	cKeyword,
	symLookupType
) AS USUAL CLIPPER
Request Example View Source

Parameters

cKeyword (Optional)
Type: Usual
The keyword to look up in the application help file. See table in the remarks section.
symLookupType (Optional)
Type: Usual
Controls the lookup type. The default is HH_KEYWORD_LOOKUP. Is used to call up Associative links in the help file. Associative Links are not displayed in the index, keywords are. For HTML Help only. The second parameter symLookupType can also be a PTR to a _winHelpInfo structure, which is sent with a WM_HELP message.

Return Value

Type: Usual
TRUE if the lookup action took place correctly; otherwise, FALSE.
Tip Tip
A TRUE value does not imply the key was found.
Remarks
The following reserved keywords do not correspond to anything coded in your application help file. Instead, they are provided by the system to give you access to certain standard help features: Reserved KeywordDescriptionHelpIndexDisplays the Contents or Index topic (whichever was displayed last) as defined in the application help file.HelpOnHelp Displays the Contents topic as defined in your Windows help file (normally WINHELP.HLP, in which the Contents topic is How to Use Help). This is not available with .CHM help. HelpSearch Displays the Search tab in the help navigation pane.For HTML Help only. # followed by a number. The number represents the ID for a test popup help. For HTML Help only and Win32Processing mode have to enabled. ~ followed by a keyword. This forces a HH_ALINK_LOOKUP. Is used to call up Associative links in the help file. Associative Links are not displayed in the index, keywords are. For HTML Help only.
Remarks
GUIs behave differently when an invalid or unknown key is looked up. Although most present an alert message to the user (something to the effect that the key could not be found), you should assume this behavior is undefined and ensure that the key being looked up exists in the help database.
See Also