Description: This function sets the help file name and (optionally) the context identifier for the window containing the specified object.
Returns: Nothing
Usage: Steady State
Format: SetHelp(Object, HelpFileName [, HelpContext])
Parameters: Object { Object value } { required } { no default: }
The object value of a module instance that is running inside the window whose help context is to be affected.
HelpFileName { text } { required } { no default: }
The file name of the help file to use if the user presses F1 while the specified window is the active window. If Invalid, when the user presses F1, the parent window of the specified window will be checked for a file name, This continues recursively until the top of the window tree is reached. If no help file name is found, the default help file is used. The default help file can be set through the Setup.ini variable "WEBHelp", or by using the EnableHelp statement.
HelpContext { varies } { optional } { no default: }
Optional help context. If absent or invalid, but the HelpFileName is valid, then the "finder" dialog for help is displayed when the user presses F1. If valid and numeric, the help file is searched for a matching topic number and help is displayed for that topic. If valid and textual, the help file is searched for an exact match on the text string in the topic index of the help file. If there is more than one text match, the index is positioned at the first partial string match. If valid, but a topic match is not found (neither textual nor numeric), the same action as an invalid HelpContext is taken. If the HelpFileName parameter is invalid, this parameter is ignored.
Comments: The setting of help file name and context for a window performed by this statement overrides those specified by Window statement parameters. When this statement stops, the settings for an affected window revert to the state [if any] set up by the Window statement parameters. If more than one of these statements references the same window, the last one to start wins the race.