Cog3DCoordinateSpaceTree.ChildNames Method

Cog3DCoordinateSpaceTree ChildNames Method

Cognex VisionPro 9.7

Returns a collection of names containing the given space's immediate children. If there are no children, the collection will hold zero items.

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

Syntax

public List<string> ChildNames(
	string spaceName,
	CogSpaceTreePathnameConstants pathnameFormat
)

public List<string> ChildNames(
	string spaceName,
	CogSpaceTreePathnameConstants pathnameFormat
)

Public Function ChildNames ( 
	spaceName As String,
	pathnameFormat As CogSpaceTreePathnameConstants
) As List(Of String)

Public Function ChildNames ( 
	spaceName As String,
	pathnameFormat As CogSpaceTreePathnameConstants
) As List(Of String)

public:
List<String^>^ ChildNames(
	String^ spaceName, 
	CogSpaceTreePathnameConstants pathnameFormat
)

public:
List<String^>^ ChildNames(
	String^ spaceName, 
	CogSpaceTreePathnameConstants pathnameFormat
)

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.

Type: List String

A collection of child space names, or an empty collection if no child spaces exist for the given coordinate space name.

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 containing the given space's immediate children. If no children exist, the collection will hold zero items.