CogCoordinateSpaceTree.ChildNames Method

CogCoordinateSpaceTree ChildNames Method

Cognex VisionPro 9.8 SR1

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.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 75.0.0.0

Syntax

public CogStringCollection ChildNames(
	string spaceName,
	CogSpaceTreePathnameConstants pathnameFormat
)

public CogStringCollection ChildNames(
	string spaceName,
	CogSpaceTreePathnameConstants pathnameFormat
)

Public Function ChildNames ( 
	spaceName As String,
	pathnameFormat As CogSpaceTreePathnameConstants
) As CogStringCollection

Public Function ChildNames ( 
	spaceName As String,
	pathnameFormat As CogSpaceTreePathnameConstants
) As CogStringCollection

public:
CogStringCollection^ ChildNames(
	String^ spaceName, 
	CogSpaceTreePathnameConstants pathnameFormat
)

public:
CogStringCollection^ 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 should be formatted.

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

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