Get All Descendents Method

LabView Local Project Settings

Get All Descendents Method

Short Name: Get All Descendents

Installed With: Base Package

Class: ProjectItem Methods

Returns project items that are descendents of the referenced item. If you specify a value for Type, this method only returns project items of the specified type.

This method returns a flat list that includes all descendents unless you use the Type, ExcludeDependencies, ExcludeBuilds, and ExcludeTargets parameters to limit what the method returns.

Note  The LabVIEW Datalogging and Supervisory Control Module supports this method in the Run-Time Engine.

Parameters

NameRequiredDescription
Get All DescendentsNoReturns an array of references to all the descendents.
TypeNoSpecifies the project item type. The following values are the most common Type values:
  • VI
  • Folder
  • Library
  • XControl
  • EXE
  • DLL
  • Source Distribution
  • Installer
  • Zip File
  • Hyperlink
Some of the values listed above are supported only on certain LabVIEW Development Systems. Refer to ni.com/labview for more information about LabVIEW Development Systems.

To determine the value of Type for a project item that is not listed above, use the Type String property to programmatically return the type of the item.
ExcludeDependenciesNoIf TRUE, does not return Dependencies or any items under Dependencies. The default is FALSE.
ExcludeBuildsNoIf TRUE, does not return Build Specifications or any items under Build Specifications. The default is FALSE.
ExcludeTargetsNoIf TRUE, does not return any targets or any items under targets. The default is FALSE.

Remarks

The following table lists the characteristics of this method.

Available in Run-Time Engine and Real-Time Operating SystemNo
Settable when the VI is runningNo
Loads the front panel into memoryNo
Need to authenticate before useNo
Loads the block diagram into memoryNo
Remote access disallowedNo
Must wait until user interface is idleNo
Available with control VIsNo
Available with global VIsNo
Available with strict type definitionsNo
Available with polymorphic VIsNo