CoordinateSpaceTree.ChildNames Method

CoordinateSpaceTree ChildNames Method

Cognex VisionPro 9.22

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.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.22.2.0

Syntax

public StringCollection ChildNames(
	string spaceName,
	SpaceTreePathnameConstants pathnameFormat
)

public StringCollection ChildNames(
	string spaceName,
	SpaceTreePathnameConstants pathnameFormat
)

Public Function ChildNames ( 
	spaceName As String,
	pathnameFormat As SpaceTreePathnameConstants
) As StringCollection

Public Function ChildNames ( 
	spaceName As String,
	pathnameFormat As SpaceTreePathnameConstants
) As StringCollection

public:
StringCollection^ ChildNames(
	String^ spaceName, 
	SpaceTreePathnameConstants pathnameFormat
)

public:
StringCollection^ ChildNames(
	String^ spaceName, 
	SpaceTreePathnameConstants pathnameFormat
)

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

pathnameFormat: Type: Cognex.Vision SpaceTreePathnameConstants
A SpaceTreePathnameConstants 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 SpaceTreePathnameConstants.
SpaceTreeException	[legal space name]:../../en/UserGuide/Content/Topics/users-guide/vision-tools-guide/fixtures-calibration/coordinate-spaces-names.htm spaceName value is not a [legal space name].
SpaceTreeException	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.