showHelp method
Displays a Help file. This method can be used with Microsoft HTML Help.
Syntax
HRESULT retVal = object.showHelp(helpURL, helpArg);
Parameters
helpURL [in]
Type: BSTRBSTR that specifies the URL of the file to be displayed as help.
helpArg [in, optional]
Type: VARIANTVARIANT that specifies a string or integer that indicates a context identifier in a Help file.
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Standards information
There are no standards that apply here.
Remarks
Only files of types .chm and .htm are supported as help files.
When implementing this method, a second Help dialog box appears when the user presses F1 or clicks Help on the menu bar. You can prevent the default Help dialog box from appearing by setting IHTMLEventObj::returnValue to false
.
This method must use a user-initiated action, such as clicking on a link or tabbing to a link and pressing enter, to open a pop-up window. The Pop-up Blocker feature in Microsoft Internet Explorer 6 blocks windows that are opened without being initiated by the user.