ProjectItem class/Get All Descendents method - Revision history

Thoric: Added a useful link to the list of valid Type strings.

2024-05-24T07:54:24Z

Added a useful link to the list of valid Type strings.

← Older revision		Revision as of 07:54, 24 May 2024
Line 37:		Line 37:
	\| '''Type'''		\| '''Type'''
	\| No		\| No
	\| Specifies which kind of project items this method returns.		\| Specifies which kind of project items this method returns. For a list of valid Type strings see [[ProjectItem]].
	\|-		\|-
	! scope="row" style="text-align:Center;" \| [[File:Boolean.png\|frameless\|border\|Boolean\|link=Boolean data type]]		! scope="row" style="text-align:Center;" \| [[File:Boolean.png\|frameless\|border\|Boolean\|link=Boolean data type]]

Q: /* Uses */

2020-06-07T22:31:19Z

Uses

← Older revision		Revision as of 22:31, 7 June 2020
Line 56:		Line 56:

	== Uses ==		== 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 ~~available~~ on the [[ProjectItem ~~class/Type String property#Uses\|ProjectItem class/Type String property page, Uses section~~]].		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 ==		== History ==

Q at 19:37, 13 May 2020

2020-05-13T19:37:42Z

← Older revision		Revision as of 19:37, 13 May 2020
Line 56:		Line 56:

	== Uses ==		== Uses ==
	The '''ProjectItem class/Get All Descendents method'' is used to get references all of the children in the ~~Project~~. 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 ~~items~~. A list of valid ''Type String'' values and their descriptions is available on the [[ProjectItem class/Type String property#Uses\|ProjectItem class/Type String property page, Uses section]].		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 available on the [[ProjectItem class/Type String property#Uses\|ProjectItem class/Type String property page, Uses section]].

	== History ==		== History ==

Q: Added link to Type String property

2020-05-13T19:35:34Z

Added link to Type String property

← Older revision		Revision as of 19:35, 13 May 2020
Line 56:		Line 56:

	== Uses ==		== Uses ==
	~~{{ambox~~\|~~text=Specific use cases for this method~~.}}		The '''ProjectItem class/Get All Descendents method'' is used to get references all of the children in the Project. 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 items. A list of valid ''Type String'' values and their descriptions is available on the [[ProjectItem class/Type String property#Uses\|ProjectItem class/Type String property page, Uses section]].

	== History ==		== History ==

Q: Category reorg

2020-05-07T14:14:26Z

Category reorg

← Older revision		Revision as of 14:14, 7 May 2020
Line 73:		Line 73:
	{{ambox\|text=Add links to external resources that would also help.}}		{{ambox\|text=Add links to external resources that would also help.}}

	~~[[Category:Method]]~~ [[Category:VI Server Method]]		[[Category:VI Server Method]]

Q: Added new method page.

2020-04-23T22:57:37Z

Added new method page.

New page

{{VIServerMethod
| classid = 74
| methodid = 35B53810
| scope=basic
| dataname = Get All Descendents
| shortname = Get All Descendents
| longname = Get All Descendents
| datatypeimage = ProjectItem Refnum Array Indicator.png
| datatype = ProjectItem Refnum Array
| invokenodeimage = ProjectItem-Get All Descendents.png
| availableinrealtime = No
| availableinruntime = Yes (Read/Write)
| loadsbd = No
| loadsfp = No
| needsauthentication = No
| remoteallowed = Yes
| settablewhenrunning = No
|}}
{{TOCright}}
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 <em>not</em> refer to children classes of the referenced project item.
==Parameters==
{| class="wikitable"
|-
! scope="column" style="text-align:Center;" | Data type
! scope="column" style="text-align:Left;" | Name
! scope="column" style="text-align:Left;" | Required
! scope="column" style="text-align:Left;" | Description
|-
! scope="row" style="text-align:Center;" | [[File:ProjectItem Refnum Array Indicator.png|frameless|border|ProjectItem Refnum Array|link=ProjectItem Refnum Array data type]]
| '''Get All Descendents'''
| Yes. Return value.
|
|-
! scope="row" style="text-align:Center;" | [[File:String.png|frameless|border|String|link=String data type]]
| '''Type'''
| No
| Specifies which kind of project items this method returns.
|-
! scope="row" style="text-align:Center;" | [[File:Boolean.png|frameless|border|Boolean|link=Boolean data type]]
| '''ExcludeDependencies'''
| No
| Specifies whether to ignore items under the <code>Dependencies</code> 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.
|-
! scope="row" style="text-align:Center;" | [[File:Boolean.png|frameless|border|Boolean|link=Boolean data type]]
| '''ExcludeBuilds'''
| No
| If TRUE, does not return Build Specifications or any items under Build Specifications. The default is FALSE.
|-
! scope="row" style="text-align:Center;" | [[File:Boolean.png|frameless|border|Boolean|link=Boolean data type]]
| '''ExcludeTargets'''
| No
| If TRUE, does not return any targets or any items under targets. The default is FALSE.
|}

== Uses ==
{{ambox|text=Specific use cases for this method.}}

== History ==
{{ambox|text=History information is needed. What changes have occurred over previous versions?}}
{| class="wikitable"
! Version
! Change(s)
|-
|[[File:LV2018.png|frameless|border|64x64px|LabVIEW 2018|link=LabVIEW 2018]]
|More info to come.
|}
== See Also ==
{{ambox|text=Add links to internal wiki pages that would also help.}}

== External Links ==
{{ambox|text=Add links to external resources that would also help.}}

[[Category:Method]] [[Category:VI Server Method]]