Short Name: GetObjHelp
Requires: VI Scripting
Class: GObject Methods
To Use: Create a method.
Returns the help information for the object.
| Data type | Name | Required | Description |
|---|---|---|---|
| help path | 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 | No | HTML filename or index keyword of the topic that is launched from the Context Help window. |
| has example | No | Indicates whether the object has an example. |
The following table lists the characteristics of this method.
| Data type | No return value |
| Available in Run-Time Engine | Yes (Read/Write) |
| 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 |