Rename method: Tree Structure class

Syntax

Rename(FromStructId, ToStructId)

Description

The Rename method renames the tree structure specified with FromStructId to the new name specified by ToStructId. Both parameters take a string value. The tree structure specified by ToStructId must be a new tree structure. You receive an error if the tree structure already exists. The change is automatically reflected in the database.

The Rename method can only be used with a closed tree structure, it cannot be used on an open tree structure. Before you use the Rename method, you must explicitly close any open tree structure objects (with the Close method.) You receive an error if there are any open tree structures.

Returns

A number: 0 if the method completes successfully.