VI class/Get VI Dependencies (Names and Paths) method

From LabVIEW Wiki
Jump to: navigation, search
VI Server Method Information
Method ID 47A
Scope Basic Development Environment
Data Name Get VI Dependencies
Short Name* Get VI Dependencies
Long Name* Get VI Dependencies (Names and Paths)
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 2
Owning Class Name VI Class
Return Data Type No return value
Invoke Node Get VI Dependencies (Names and Paths)
Available in Real-Time Operating SystemYes
Available in Run-Time EngineYes (Read/Write)
Available with control VIsYes
Available with global VIsYes
Available with polymorphic VIsYes
Available with strict type definitionsYes
Loads the block diagram into memoryNo
Loads the front panel into memoryNo
Must wait until user interface is idleNo
Need to authenticate before useNo
Remote access allowedYes
Settable when the VI is runningYes

This method returns the names and paths of the VI dependencies of a VI. You can use this method to return a specific subset of the total set of VI dependencies of a VI. This method does not return non-VI dependencies, such as project libraries, XControls, classes, and statecharts.

LabVIEW combines the parameter values you specify using the logical AND operator to determine which dependencies to return. For example, you must pass TRUE to both Static VI Refs? and Include Control VIs? in order for LabVIEW to return a static VI reference to a custom control or indicator.

By default, this method does not load the block diagram into memory. However, if you specify certain input values, LabVIEW loads the block diagram.

Parameters

Data type Name Required Description
String Array Dependency Names No Returns the fully qualified names, which include the names of owning project libraries, of VI dependencies. This parameter is similar to the This VI's SubVIs item in the View Menu.
Path Array Dependency Paths No Returns the directory paths of VI dependencies.
Boolean Whole Hierarchy? No If FALSE (default), LabVIEW returns only the dependencies of the current VI. If TRUE, LabVIEW returns all dependencies for the entire VI hierarchy.
Enum U8 Commented Out Diagrams? No Specifies whether LabVIEW returns dependencies that LabVIEW does not invoke, such as those in the Disable case of a Diagram Disable structure. Also, if you wire a constant to the selector terminal of a Case structure, LabVIEW considers dependencies in non-executing cases to be commented out and does not invoke them.
Boolean Static VI Refs? No If TRUE, LabVIEW returns VIs referenced with Static VI Reference functions, including the top-level VI if it contains a reference to itself. The default is FALSE.
Enum U8 Dynamic Dispatching? No Specifies which VIs LabVIEW returns if the VI contains a dynamic dispatch subVI.
Boolean Include Missing Items? No If TRUE, LabVIEW returns names and paths for any missing dependencies. LabVIEW returns dependencies as missing if they are corrupt, saved in a later version of LabVIEW, or if they cannot be found on disk. Since the types of missing dependencies are unknown, LabVIEW returns missing dependencies regardless of how you configure other parameters. The default is FALSE.
Boolean Include Standard VIs? No If TRUE (default), LabVIEW returns subVIs, including polymorphic VI instances and instantiations of generic VIs.
Enum U8 Include Reentrant Clones? No Specifies whether LabVIEW returns clone VIs of reentrant VIs that are dependencies.
Boolean Include Poly VIs? No If TRUE (default), LabVIEW returns polymorphic VIs.
Boolean Include Global VIs? No If TRUE (default), LabVIEW returns global VIs.
Boolean Include Control VIs? No If TRUE (default), LabVIEW returns type definitions and strict type definitions.
Boolean Include Generic VIs? No If TRUE (default), LabVIEW returns generic VIs.
Boolean Include Alternate Call Setups? No
Boolean Keep Express and Malleable VIs? No
Boolean Load Block Diagram? No If TRUE, LabVIEW loads this VI block diagram before it evaluates whether any dependencies exist. If you open a block diagram from a location that is different from the location in which it is originally saved, LabVIEW may load new subVIs into memory. This may affect the Include Alternate Call Setup VIs? option. The default is FALSE.

Uses

History

Version Change(s)
LabVIEW 2009 This method was added in LabVIEW 2009.

See Also

External Links