Returns the help information for the object.

Parameters

Name Data type Required Description
help path ipath.png No

Path or symbolic path to the HTML file or to the compiled help file linked to from the Context Help window. If this field is empty, the blue Detailed help link does not appear in the Context Help window, and the Detailed help button is dimmed.
help tag istr.png No

HTML filename or index keyword of the topic that is launched from the Context Help window.
has example ibool.png No

Indicates whether the object has an example.

Remarks

The following table lists the characteristics of this method.

Short Name GetObjHelp
Data type No return value
Available in Run-Time Engine Yes
Available in Real-Time Operating System Yes
Settable when the VI is running Yes
Loads the front panel into memory Yes
Need to authenticate before use No
Loads the block diagram into memory Yes
Remote access allowed Yes