UnRegisterHelpLinks

hs.UnRegisterHelpLinks(plug_name As String)

 

(Applies to HomeSeer HS2 versions after 2.2.0.0)

 

This call removes all of the registered help resource links for the plug-in or script/ASPX registered with the provided name.  See RegisterHelpLink for more information on registering a help resource.

 

Help resources that exist on the hard drive such as a static html document do not need to be explicitly unregistered.  However, when a help resource is provided by a plug-in or when the help resource requires the use of a plug-in, then this procedure should be used to unregister the resource when the plug-in shuts down (e.g. ShutdownIO) so the user does not have a link displayed that will not work properly.

 

Here are the parameters for this procedure call:

 

 

Example:

 

To unregister all help resources for the Acme_Widgets plug-in, which were registered using a plug-in name of "Acme Application"

 

hs.UnRegisterHelpLinks("Acme Application")