CaRenameItem

CaRenameItem encapsulates the RenameItem process. It cannot be instantiated directly. The RenameItem process can be set in the CaContext object either by name or object ID. The CaRenameItem object can only be retrieved from the CaContext after it has been set. Set the item either by object ID or by name and path. This is a logical rename that creates a new version of an item with a new item name.

Usage

Set the Project, State, and RenameItem Context.
Set the RenameItem attributes, including the item to be renamed and the new item name.
Invoke the Execute function.

Public Methods

SetDescription
SetItemObjId
SetItemName
SetItemPath
SetNewItemName
SetClientDir
SetCreateOnBranch
SetCreateOnTrunk
SetBranchOut
SetRefactorMode
SetRemoteMachineName
SetRemoteUserName
SetRemotePassword
SetCallBack
SetCBUserData
GetDescription
GetItemObjId
GetItemName
GetItemPath
GetNewItemName
GetClientDir
GetCreateOnBranch
GetCreateOnTrunk
GetBranchOut
GetRefactorMode
GetRemoteMachineName
GetRemoteUserName
GetRemotePassword
GetCallBack
GetCBUserData
Execute

More information:

HSDK Programming Fundamentals
CaContext