Cog3DCoordinateSpaceTree.DeleteSubtree Method

Cog3DCoordinateSpaceTree DeleteSubtree Method

Cognex VisionPro 9.5

Delete the subtree rooted at spaceName. spaceName and all of its children will be removed from the tree.

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

Syntax

public void DeleteSubtree(
	string spaceName
)

public void DeleteSubtree(
	string spaceName
)

Public Sub DeleteSubtree ( 
	spaceName As String
)

Public Sub DeleteSubtree ( 
	spaceName As String
)

public:
void DeleteSubtree(
	String^ spaceName
)

public:
void DeleteSubtree(
	String^ spaceName
)

spaceName: Type: System String
A valid nonqualified or fully-qualified space name that indicates the root space of the subtree to delete.

Events

Event Type	Reason
Cog3DCoordinateSpaceTree SubtreeDeleted	Fires when a subtree is deleted.

Exceptions

Exception	Condition
ArgumentException	spaceName cannot be the root space.
CogSpaceTreeInvalidNameSyntaxException	spaceName 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

Deletes the subtree rooted at the given space name. All children of the space are also removed from the tree.

If this method encounters the root node of a tree embedded using the AddTree(String, Cog3DCoordinateSpaceTree, ICog3DTransform, CogAddSpaceConstants) method, it unlinks the embedded tree, and other clients of that embedded tree can continue to use it.