Get Help Info Method

LabVIEW 2013 Help

Edition Date: June 2013

Part Number: 371361K-01

»View Product Info

Short Name: GetObjHelp

Requires: VI Scripting

Class: GObject Methods

To Use: Create a method.

Returns the help information for the object.


Data typeNameRequiredDescription
help pathNoPath 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 tagNoHTML filename or index keyword of the topic that is launched from the Context Help window.
has exampleNoIndicates whether the object has an example.


The following table lists the characteristics of this method.

Data typeNo return value
Available in Run-Time EngineYes (Read/Write)
Available in Real-Time Operating SystemYes
Settable when the VI is runningYes
Loads the front panel into memoryYes
Need to authenticate before useNo
Loads the block diagram into memoryYes
Remote access allowedYes
Must wait until user interface is idleNo
Available with control VIsYes
Available with global VIsYes
Available with strict type definitionsNo
Available with polymorphic VIsNo


Not Helpful