Adobe 65030089 - Robohelp - PC Using Manual page 240

USING ROBOHELP HTML 9
Context-sensitive Help
Note: In the following examples, the API shares the same parameters regardless of output type. The only change made
is the location of the Help file.
Stores the full path to the start page and a dialog name in a string variable called
WebHelp/FlashHelp
StrPathAndWindow. An example of this string is "C:\Program
Files\MyApplication\WebHelp\MyStartPage.htm>MyWindow."
Stores the full path to the server and a window name in a string variable called StrPathAndWindow.
WebHelp Pro
Check with the web administrator to determine whether the project name is required. (The project name is
required if the Auto-Merge option in the RoboHelp Server Configuration Manager is set to Off.)
An example of this string is
name>&quesn=<search-query>
Stores the full path to the CHM file and a dialog name in a string variable called StrPathAndWindow.
HTML Help
An example of this string is "C:\Program Files\MyApplication\MyHelp.chm>MyWindow."
Do not hard-code the string variable StrPathAndWindow.
To call a Help topic, call the function
7
to , and
HH_HELP_CONTEXT
RH_ShowHelp syntax
RH_ShowHelp syntax
RH_ShowHelp(hParent As Long, a_pszHelpFile As String, uCommand As Long, dwData as Long) As
Boolean
Example:
To open the topic mapped to number 1:
Public cshObject as new RoboHelp_CSH .RH_ShowHelp Me.HWND, StrPathAndWindow,
cshObject.HH_HELP_CONTEXT, 1;
Notes:
• In WebHelp Pro projects, the new context-sensitive Help API is supported only with RoboHelp Server.
• Create one global RoboHelp_CSH object to use for all context-sensitive Help calls.
Airplane Help for Visual Basic applications
If using Airplane Help, associate offline Help before making function calls.
Syntax
Public Function RH_AssociateOfflineHelp(pszPrimaryHelpSource As String, pszBackupHelpSource As
String) As Boolean
Example
strOnline = "http:// www.mycompany.com/roboapi.asp?project=myproject"
strOffline = "C:\Program Files\My App\WebHelp\StartPage.htm"
Public cshObject as new RoboHelp_CSH
cshObject. RH_AssociateOfflineHelp strOnline, strOffline
http://<servername>/robohelp/rest/search?project=<project-
with
RH_ShowHelp
set to the map ID of the topic.
dwData
' Should be global object
Last updated 12/14/2011
set to
a_pszHelpFile StrPathAndWindow
234
, set
uCommand