Cog3DCoordinateSpaceTree.ChangeName Method

Cog3DCoordinateSpaceTree ChangeName Method

Cognex VisionPro 9.5

Change the given space name to newSpaceName.

Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D.Core (in Cognex.VisionPro3D.Core.dll) Version: 69.0.0.0

Syntax

C++

Copy to Clipboard Print

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 the tree.

newSpaceName: Type: System String
A valid nonqualified space name for the new coordinate space.

Events

Event Type	Reason
Cog3DCoordinateSpaceTree NameChanged	Fires when the name changes.

Exceptions

Exception	Condition
CogSpaceTreeDuplicateChildNameException	newSpaceName is already a child of spaceName's parent space.
CogSpaceTreeInvalidNameSyntaxException	spaceName or newSpaceName is not a legal space name.
CogSpaceTreeNameNotUniqueException	spaceName is a nonqualified space name and more than one instance of it exists in this tree.
CogSpaceTreeNameNotInTreeException	spaceName does not exist in this tree.

Remarks

Change the name of a space in this tree. If the spaceName is a fully-qualified pathname this method modifies only the trailing nonqualified name. The new space name must meet the syntactical requirements of a nonqualified space names.

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