Cog3DCoordinateSpaceTree.AllChildNames Method

Cog3DCoordinateSpaceTree AllChildNames Method

Cognex VisionPro

Returns a collection of names that includes all the children, grandchildren, great-grandchildren, etc. of the given space. If there are no children, the collection will hold zero items.

Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D.Core (in Cognex.VisionPro3D.Core.dll) Version: 65.1.0.0

Syntax

C++

Copy to Clipboard Print

public List<string> AllChildNames(
	string spaceName,
	CogSpaceTreePathnameConstants pathnameFormat,
	bool childrenOnly
)

public List<string> AllChildNames(
	string spaceName,
	CogSpaceTreePathnameConstants pathnameFormat,
	bool childrenOnly
)

Public Function AllChildNames ( 
	spaceName As String,
	pathnameFormat As CogSpaceTreePathnameConstants,
	childrenOnly As Boolean
) As List(Of String)

Public Function AllChildNames ( 
	spaceName As String,
	pathnameFormat As CogSpaceTreePathnameConstants,
	childrenOnly As Boolean
) As List(Of String)

public:
List<String^>^ AllChildNames(
	String^ spaceName, 
	CogSpaceTreePathnameConstants pathnameFormat, 
	bool childrenOnly
)

public:
List<String^>^ AllChildNames(
	String^ spaceName, 
	CogSpaceTreePathnameConstants pathnameFormat, 
	bool childrenOnly
)

Parameters

spaceName: Type: System String
A valid nonqualified or fully-qualified space name to find in this coordinate space tree.

pathnameFormat: Type: Cognex.VisionPro CogSpaceTreePathnameConstants
A CogSpaceTreePathnameConstants value that indicates how the returned name(s) should be formatted.

childrenOnly: Type: System Boolean
If false, the supplied space name is included as a separate item in the returned collection of space names. If true, the supplied space name does not appear as a collection item.

Return Value

Type: List String

A collection that contains a listing of the child coordinate space names of the given space name. If no children exist, the collection has no items.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The pathnameFormat value is not a member of CogSpaceTreePathnameConstants.
CogSpaceTreeInvalidNameSyntaxException	spaceName is not a legal space name.
CogSpaceTreeNameNotUniqueException	spaceName is a nonqualified space name and more than one instance of it exists in this tree.
CogSpaceTreeNameNotInTreeException	spaceName does not exist in this tree.

Remarks

Returns a collection of names that includes all the descendants of the given space. If no children exist and childrenOnly is true, the collection has no items.