CaRenamePath

CaRenamePath encapsulates the RenamePath process. It cannot be instantiated directly. The RenamePath process can be set in the CaContext object either by name or object ID. The CaRenamePath object can only be retrieved from the CaContext after it has been set. Set the item path to be renamed either by object ID or by path name. This is a logical rename that creates new versions of an path item (and any sub-items of the source path) with the new item path name.

Usage

Set the Project, State, and RenamePath Context.
Set the RenamePath attributes, including the item path to be renamed.
Invoke the Execute function.

Public Methods

SetDescription
SetItemPathObjId
SetItemPath
SetNewItemPathName
SetCreateOnBranch
SetCreateOnTrunk
SetBranchOut
SetRefactorMode
GetDescription
GetItemPathObjId
GetItemPath
GetNewItemPathName
GetCreateOnBranch
GetCreateOnTrunk
GetBranchOut
GetRefactorMode
Execute

More information:

HSDK Programming Fundamentals
CaContext