GetAllDescendents Method

LabView ActiveX Properties and Methods

GetAllDescendents Method

Installed With: Base Package

Class: ProjectItem Methods (ActiveX)

Returns LabVIEW 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.

Syntax

object.GetAllDescendents(type, [excludeDependencies], [excludeBuilds], [excludeTargets])

Parameters

NameTypeDescription
typeStringSpecifies 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 TypeString property to programmatically return the type of the item. For cross-language reasons, this string is always in English.
excludeDependenciesBooleanIf TRUE, does not return Dependencies or any items under Dependencies. The default is FALSE.
excludeBuildsBooleanIf TRUE, does not return Build Specifications or any items under Build Specifications. The default is FALSE.
excludeTargetsBooleanIf TRUE, does not return any targets or any items under targets. The default is FALSE.

Return Value

1D array of ProjectItems