GObject class/Get Help Info method

From LabVIEW Wiki
Jump to: navigation, search
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 Get Help Info
Available in Real-Time Operating SystemYes
Available in Run-Time EngineYes (Read/Write)
Loads the block diagram into memoryYes
Loads the front panel into memoryYes
Need to authenticate before useNo
Remote access allowedYes
Settable when the VI is runningYes

Returns the help information for the object.

Parameters

Data type Name Required Description
Path 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.
String help tag No HTML filename or index keyword of the topic that is launched from the Context Help window.
Boolean has example No Indicates whether the object has an example.

Uses

History

Version Change(s)
LabVIEW 2018 More info to come.

See Also

External Links