Customizing the Path to the Essbase Login Help File

In Windows environments, the EsxAutoLogin() call displays a dialog box that contains a Help button. It also provides access to other dialog boxes with their own Help buttons. Clicking the Help button displays the Essbase System Login help topic (or the file specified in ESX_INIT_T), which is shipped with the Oracle Essbase Spreadsheet Add-in User's Guide online help.

If you don't write your own Help file, you can simply supply the default help to your users with the product installation.

Setting the HelpFile Field of the Initialization Structure

You can specify the API help file by setting the HelpFile field in the initialization structure to a string indicating the full path and file name of the API help file. The API looks for the help file whenever the user invokes a help screen.

For example, if the API help screens are included in a file called PRODUCT.HLP in the C:\PRODUCT\HELP directory set the initialization structure to the following path:

ESS_INIT_T InitStruct;   InitStruct.HelpFile = "C:\PRODUCT\HELP\PRODUCT.HLP";

For Visual Basic, set the path this way:

Dim pInit as ESB_INIT_T
pInit.HelpFile="C:\PRODUCT\HELP\PRODUCT.HLP"