CoordinateSpaceTree.FindNames Method

CoordinateSpaceTree FindNames Method

Cognex VisionPro 9.22 SR1

Find the given SpaceName in this tree and return a collection containing the fully-qualified pathname(s) that are found. The collection may contain zero, one, or more items.

Namespace: Cognex.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.22.2.0

Syntax

C++

Copy to Clipboard Print

public StringCollection FindNames(
	string spaceName
)

public StringCollection FindNames(
	string spaceName
)

Public Function FindNames ( 
	spaceName As String
) As StringCollection

Public Function FindNames ( 
	spaceName As String
) As StringCollection

public:
StringCollection^ FindNames(
	String^ spaceName
)

public:
StringCollection^ FindNames(
	String^ spaceName
)

Parameters

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

Return Value

Type: StringCollection

A collection of space names; or an empty collection if the given name does not exist in the tree.

Exceptions

Exception	Condition
SpaceTreeException	spaceName value is not a legal space name.

Remarks

Finds the given coordinate space name in this tree and returns a collection containing zero or more fully-qualified pathnames that are found. The returned collection contains more than one space name only if the given spaceName is nonqualified and exists at multiple locations within the coordinate space tree. You can use FindNames to determine if a space name is valid and exists in this tree, or to convert a nonqualified space name to one or more fully-qualified space names. FindNames is similar to LookUpName, but it does not generate an error if the given space name exists more than once in the tree or does not exist.