hiObShowTag
hiObShowTag(
t_tool
t_tag
t_version
)
=> t / nil
Description
Opens Doc Assistant to display the help document related to the specified tool and tag.
Arguments
|
t_tool
|
Name of the tool from which the help is being called. This maps to the name of a tag file in the documentation hierarchy.
|
|
t_tag
|
Name of the tag used to reference the documentation page to open.
|
|
t_version
|
Version of the help document. Use "" to open the document in the default, usually the latest, version.
|
Values Returned
|
t
|
Help document opened successfully.
|
|
nil
|
Failed to open the help document.
|
Examples
Opens the latest version of the documentation page referenced by the schObjPropForm tag entry in the Schematics.tgf file.
hiObShowTag("Schematics" "schObjPropForm" "")
Related Topics
Online Help Functions
hiHelp
Return to top
