GetVIDependencies Method

LabVIEW 2018 Help


Edition Date: March 2018
Part Number: 371361R-01
View Product Info

DOWNLOAD (Windows Only)


LabVIEW 2016 Help
LabVIEW 2017 Help
LabVIEW 2018 Help
LabVIEW 2019 Help
LabVIEW 2020 Help

Requires: Base Development System

Class: VI Methods (ActiveX)

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.

Syntax

object.GetVIDependencies([dependencyNames], [dependencyPaths], [wholeHierarchy], [commentedOut], [staticVIRefs], [dynDispatching], [missingItems], [standardVIs], [reentrantClones], [polyVIs], [globalVIs], [controlVIs], [genericVIs], [callSetupVIs], [expressVIs], [loadDiagram])

Parameters

NameTypeDescription
dependencyNamesstringReturns the names of the VI dependencies.
dependencyPathsarray of strings by refReturns the directory paths of the VI dependencies.
wholeHierarchyBooleanIf FALSE (default), LabVIEW returns only the dependencies of the current VI. If TRUE, LabVIEW returns all dependencies for the entire VI hierarchy. Use the TRUE case to perform hierarchy traversals without having to implement recursion detection yourself.
commentedOutvariantSpecifies whether LabVIEW returns dependencies to VIs in diagrams 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.
staticVIRefsBooleanIf 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.
dynDispatchingvariantSpecifies which VIs LabVIEW returns if the VI contains a dynamic dispatch subVI.
missingItemsBooleanIf 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.
standardVIsBooleanIf TRUE (default), LabVIEW returns subVIs, including polymorphic VI instances and instantiations of generic VIs.
reentrantClonesBooleanSpecifies whether LabVIEW returns clone VIs of reentrant VIs that are dependencies.
polyVIsBooleanIf TRUE (default), LabVIEW returns polymorphic VIs.
globalVIsBooleanIf TRUE (default), LabVIEW returns global VIs.
controlVIsBooleanIf TRUE (default), LabVIEW returns type definitions and strict type definitions.
genericVIsBooleanIf TRUE (default), LabVIEW returns generic VIs.
callSetupVIsBoolean controlIf TRUE (default), LabVIEW returns subVI calls that use the alternative Call Setup options, such as Reload for each call or Load and retain on first call. Because these VIs are dynamically loaded, they may or may not be in memory. To include any VIs missing from memory, set the Include Missing Items to TRUE. To bring any missing items into memory in a development environment, set Load Block Diagram to TRUE.
expressVIsBoolean controlIf TRUE, LabVIEW returns Express VIs as dependencies. If you want edit-time Express VI dependencies, set Keep Express VIs? to TRUE. If you want run-time Express VI dependencies, set Keep Express VIs? to FALSE. Regardless of this setting, LabVIEW returns any subVI calls that the Express VI scripts into the referenced VI.
loadDiagramBoolean controlIf 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.

Return Value

none

WAS THIS ARTICLE HELPFUL?

Not Helpful