GObject class/Get Help Info method
| VI Server Method Information | |
|---|---|
| Method ID | 632A407 |
| Scope | VI Scripting |
| Data Name | GetObjHelp |
| Short Name* | GetObjHelp |
| Long Name* | Get Help Info |
| * Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE. | |
| Owning Class ID | 36 |
| Owning Class Name | GObject Class |
| Return Data Type | No return value |
| Invoke Node | 
|
| Available in Real-Time Operating System | Yes |
| Available in Run-Time Engine | Yes (Read/Write) |
| Loads the block diagram into memory | Yes |
| Loads the front panel into memory | Yes |
| Need to authenticate before use | No |
| Remote access allowed | Yes |
| Settable when the VI is running | Yes |
Returns the help information for the object.
Parameters
| 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. |
Uses
 |
Specific use cases for this method. |
History
| |
History information is needed. What changes have occurred over previous versions? |
| Version | Change(s) |
|---|---|
|
More info to come. |
See Also
| |
Add links to internal wiki pages that would also help. |
External Links
| |
Add links to external resources that would also help. |