CogCoordinateSpaceTree.ChangeName Method

CogCoordinateSpaceTree ChangeName Method

Cognex VisionPro 9.8

Change the given space name to NewSpaceName.

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

Syntax

public void ChangeName(
	string spaceName,
	string newSpaceName
)

public void ChangeName(
	string spaceName,
	string newSpaceName
)

Public Sub ChangeName ( 
	spaceName As String,
	newSpaceName As String
)

Public Sub ChangeName ( 
	spaceName As String,
	newSpaceName As String
)

public:
void ChangeName(
	String^ spaceName, 
	String^ newSpaceName
)

public:
void ChangeName(
	String^ spaceName, 
	String^ newSpaceName
)

Parameters

spaceName: Type: System String
A valid nonqualified or fully-qualified space name to change. This space must exist in this CogCoordinateSpaceTree.

newSpaceName: Type: System String
A valid nonqualified or fully-qualified space name for the new coordinate space.

Exceptions

Exception	Condition
CogSpaceTreeInvalidNameSyntaxException	newSpaceName or spaceName is not a valid space name.
CogSpaceTreeDuplicateChildNameException	newSpaceName is already the name of a child of spaceName's parent space.
CogSpaceTreeNotUniqueException	spaceName is a nonqualified space name and more than one instance of it exists in this tree.

Remarks

Change the name of a space in this tree. If the given space name is a fully-qualified pathname, ChangeName(String, String) modifies only the trailing nonqualified name. The new space name must meet the syntactical requirements of nonqualified or fully-qualified space names.

Note: If you want to modify the root name, the RootName property permits less restrictive space names.