hs.RegisterHelpLink(link As String, link_text As String, plugin_name As String, Optional sequence As Integer)
(Applies to HomeSeer HS2 versions after 2.2.0.0)
This call registers a help link resource with HomeSeer so that it will appear on the help (/help) page of HomeSeer. This function can be used by both plug-ins and scripts, and it does not require an object reference as RegisterLinkEx and RegisterConfigLink do.
Here are the parameters for this procedure call:
link - This is the actual URL link, and it is case sensitive if it refers to a plug-in registered web page and with some external web pages. If you are referring to a help resource on the local system under the HTML directory, it should start with "/" so that it is referenced relative to the root of the HomeSeer web server. If it starts with http: or ftp:, a note will be appended to the link letting the user know that an Internet connection is required to access the link.
link_text - This is the text that will be displayed for the link on the help page.
plugin_name - This is the plug-in name (IFACE_NAME) or some sort of unique identifier for a script or ASPX based system. This identifier is used to group multiple links from the same plug-in or script/ASPX together, and it is displayed as a heading on the help page. It is not required that a plug-in use its IFACE_NAME value, but it is necessary to use the same text when you use UnRegisterHelpLinks. For example, if your plug-in name is "MediaPlayer", you can instead use "Windows Media Player" so that the title is more descriptive.
sequence - this is an optional parameter that is used if provided to set the order in which multiple links from the same plug-in or script/ASPX are displayed. If there is a preference as to the order that multiple links under the same heading (plugin_name) are to be displayed, then set the first one to be displayed to have an order of 0, the next one to 1, then 2, 3, 4, etc. If you are registering multiple links under the same "plugin_name" then this parameter must be used with a unique sequence value for each link.
Example:
hs.RegisterHelpLink("/MyApplication/MyHelpFile.htm","Help For Cool App", "My Cool Application")