Description
Displays pop-up help for the specified control.
Applies to
Any control
Syntax
ShowPopupHelp ( helpfile, control, contextid )
Argument |
Description |
---|---|
helpfile |
String for the Help file name to be used |
control |
Dragobject for which the pop-up help is displayed |
contextid |
Long for the context ID number |
Return value
Integer.
Returns 1 if the function succeeds and -1 if an error occurs.
Usage
A typical location for the ShowPopupHelp call is in the Help event of a response window with the Context Help property enabled. Events relating to movement of the cursor over a control or to the dragging of a control or object are also logical places for a ShowPopupHelp call.
You must type a correct context ID number for the contextid argument or you get a message that a Help topic does not exist for the item calling the ShowPopupHelp function.
Examples
This example calls a help file in a subdirectory of the current directory:
ShowPopupHelp ( "Help/my_app.hlp", this, 510)
See also