CogCoordinateSpaceTree.AllChildNames Method

CogCoordinateSpaceTree AllChildNames Method

Cognex VisionPro

Returns a collection of names that recursively 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.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 65.1.0.0

Syntax

C++

Copy to Clipboard Print

public CogStringCollection AllChildNames(
	string spaceName,
	CogSpaceTreePathnameConstants pathnameFormat,
	bool childrenOnly
)

public CogStringCollection AllChildNames(
	string spaceName,
	CogSpaceTreePathnameConstants pathnameFormat,
	bool childrenOnly
)

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

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

public:
CogStringCollection^ AllChildNames(
	String^ spaceName, 
	CogSpaceTreePathnameConstants pathnameFormat, 
	bool childrenOnly
)

public:
CogStringCollection^ 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 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, does not appear as a collection item.

Return Value

Type: CogStringCollection

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

Exceptions

Exception	Condition
ArgumentException	pathnameFormat value is not a member of CogSpaceTreePathnameConstants.
CogSpaceTreeInvalidNameSyntaxException	spaceName value is not a legal space name.
CogSpaceTreeNotUniqueException	spaceName is a nonqualified space name and more than one instance of it exists 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.