ProjectItem class/Get All Descendents method

From LabVIEW Wiki
Jump to: navigation, search
VI Server Method Information
Method ID 35B53810
Scope Basic Development Environment
Data Name Get All Descendents
Short Name* Get All Descendents
Long Name* Get All Descendents
* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.
Owning Class ID 74
Owning Class Name ProjectItem Class
Return Data Type ProjectItem Refnum Array data type

ProjectItem Refnum Array

Invoke Node Get All Descendents
Available in Real-Time Operating SystemNo
Available in Run-Time EngineYes (Read/Write)
Loads the block diagram into memoryNo
Loads the front panel into memoryNo
Need to authenticate before useNo
Remote access allowedYes
Settable when the VI is runningNo

Recursively returns project items that appear under the referenced item in the project tree. For example, if you call this method on project library A that contains an inner project library B, the method returns items owned both by library A and library B.

For this method, the term descendents does not refer to children classes of the referenced project item.

Parameters

Data type Name Required Description
ProjectItem Refnum Array Get All Descendents Yes. Return value.
String Type No Specifies which kind of project items this method returns. For a list of valid Type strings see ProjectItem.
Boolean ExcludeDependencies No Specifies whether to ignore items under the Dependencies folder if the referenced item is a project. If the referenced item is a target, this input specifies whether to exclude items under the target. If the referenced item is neither a project nor a target, this input has no effect on the output of this method.
Boolean ExcludeBuilds No If TRUE, does not return Build Specifications or any items under Build Specifications. The default is FALSE.
Boolean ExcludeTargets No If TRUE, does not return any targets or any items under targets. The default is FALSE.

Uses

The ProjectItem class/Get All Descendents method is used to get references to all of the children under the input referenced ProjectItem. The parameter Type is used to filter to just those that match that specific type. The ProjectItem class/Type String property can be used to get the Type of an item. A list of valid Type String values and their descriptions are listed on the ProjectItem page.

History

Version Change(s)
LabVIEW 2018 More info to come.

See Also

External Links