CogCoordinateSpaceTree.VerifyName Method

CogCoordinateSpaceTree VerifyName Method

Cognex VisionPro 9.8

Return true if the given SpaceName is a unique name in this tree. Return false if SpaceName cannot be found. The formatted name, or "", can be obtained through the optional FoundName argument.

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

Syntax

C++

Copy to Clipboard Print

public bool VerifyName(
	string spaceName,
	CogSpaceTreePathnameConstants pathnameFormat,
	out string foundName
)

public bool VerifyName(
	string spaceName,
	CogSpaceTreePathnameConstants pathnameFormat,
	out string foundName
)

Public Function VerifyName ( 
	spaceName As String,
	pathnameFormat As CogSpaceTreePathnameConstants,
	<OutAttribute> ByRef foundName As String
) As Boolean

Public Function VerifyName ( 
	spaceName As String,
	pathnameFormat As CogSpaceTreePathnameConstants,
	<OutAttribute> ByRef foundName As String
) As Boolean

public:
bool VerifyName(
	String^ spaceName, 
	CogSpaceTreePathnameConstants pathnameFormat, 
	[OutAttribute] String^% foundName
)

public:
bool VerifyName(
	String^ spaceName, 
	CogSpaceTreePathnameConstants pathnameFormat, 
	[OutAttribute] String^% foundName
)

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.

foundName: Type: System String
An optional parameter through which you can obtain the space name, formatted according to the pathnameFormat setting. If VerifyName(String, CogSpaceTreePathnameConstants, String ) returns False, foundName contains "".

Return Value

Type: Boolean

True if the given spaceName is unique. False if the name is not found in the tree.

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

You can use VerifyName(String, CogSpaceTreePathnameConstants, String ) to verify that a given space name is legal and exists in the coordinate space tree. It returns true if the given spaceName is a unique name in this tree; false if spaceName cannot be found.

VerifyName(String, CogSpaceTreePathnameConstants, String ) is similar to LookUpName(String, CogSpaceTreePathnameConstants), however it does not generate an error if the specified spaceName does not exist in the tree.