RenameWorkspaceItem
Description
Renames a workspace item and returns Boolean True if successful and otherwise returns False.
When specifying a path to a workspace item, Folder names must be separated with a forward slash (/) character.
This method supports MultiSite operations and may be useful in resolving naming conflicts. You can use this method to change an ambiguous workspace item name to an unambiguous name. For example, a replica site might have charts, queries, reports, and report formats with the same pathnames as the local site. This means that there is a potential for duplicate names. This method allows you to change the name of a workspace item so that it no longer conflicts with any other items that were created at another site. It also removes the site-extension from those names when they are displayed. You must have access and mastership of the workspace item to change its name. The method returns False if you do not have access or if the specified location does not exist.
Syntax
VBScript
success = workspace.RenameWorkspaceItem old_path, new_name
Perl
$success = $workspace->RenameWorkspaceItem(old_path, new_name);
- Identifier
- Description
- workspace
- The Workspace object obtained from the current session.
- old_path
- The existing path to a workspace item. Folder names must be separated with a forward slash (/) character.
- new_name
- A String containing the new name of the workspace item.
- Return value
- Returns Boolean True if successful; False if failed.