CogCoordinateSpaceTree.LookUpName Method

CogCoordinateSpaceTree LookUpName Method

Cognex VisionPro 9.8 SR1

Look up the given SpaceName in this tree and, if found, returns an appropriately formatted copy of the name.

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 75.0.0.0

Syntax

public string LookUpName(
	string spaceName,
	CogSpaceTreePathnameConstants pathnameFormat
)

public string LookUpName(
	string spaceName,
	CogSpaceTreePathnameConstants pathnameFormat
)

Public Function LookUpName ( 
	spaceName As String,
	pathnameFormat As CogSpaceTreePathnameConstants
) As String

Public Function LookUpName ( 
	spaceName As String,
	pathnameFormat As CogSpaceTreePathnameConstants
) As String

public:
String^ LookUpName(
	String^ spaceName, 
	CogSpaceTreePathnameConstants pathnameFormat
)

public:
String^ LookUpName(
	String^ spaceName, 
	CogSpaceTreePathnameConstants pathnameFormat
)

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.

Return Value

Type: String

The formatted 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.
CogSpaceTreeNotInTreeException	spaceName does not exist in this tree.

Remarks

Looks up the given coordinate space name in this tree and, if found, returns an appropriately formatted copy of the name. You can use LookUpName(String, CogSpaceTreePathnameConstants) to verify that a given space name is valid and exists in the tree. This method is similar to FindNames(String), except that it requires that only one instance of the name exist in the tree.