setfunhelp


(setfunhelp c:cmd [ hlpFile [ hlpTopic [ hlpCmd ] ] ] )

This function registers a help entry for command c:cmd in specified hlpFile help file, using the topic hlpTopic and optionally controls the initial help browser tab by hlpCmd.

Arguments

c:cmd  (string, c: prefix required) the name of a command
hlpFile  (string, optional) the name of the help file; extension can be omitted, .chm is first searched, then .hlp extension is used to find the help file
hlpTopic  (string, optional) the help topic to be shown
hlpCmd  (string, optional) a string specifying the help browser command for the initial tab (browser specific)

Return

if successful, c:cmd string is returned, NIL otherwise

Example

(setfunhelp "C:SelectPipe" "PipeHelp.chm" "PipeHelp")

(setfunhelp "c:test" "www.cadtools.de/ProgramHelp/index.html")
(setfunhelp "c:test" "www.cadtools.de/ProgramHelp/index.html" "/topic")

important for all cases :
as the (help) function can use a second string argument ("content index"), it is important how to handle it :
BricsCAD and AutoCAD just combine the first string (the main help URL) and the second string together;
so it is important that the second (optional) string then contains the delimiter, like the "/" character

(setfunhelp "c:test" "www.cadtools.de/ProgramHelp/index.html")
(setfunhelp "c:test" "www.cadtools.de/ProgramHelp" "/index.html")
works

(help "c:test" "www.cadtools.de/ProgramHelp/index.html/")
does not work

So to have context-specific pages, add the separator to the second "context" string.

Remarks




©  Bricsys NV. All rights reserved.