CaRemoveItem

CaRemoveItem encapsulates the RemoveItem process. It cannot be instantiated directly. The RemoveItem process can be set in the CaContext object either by name or object ID. The CaRemoveItem object can only be retrieved from the CaContext after it has been set. The administrator sets default attribute values. Set the item either by object ID or by name and path. If name is used then the recursive flag is relevant. This is a logical remove that creates a version with a Delete tag.

Usage

Set the Project, State, and RemoveItem Context.
Set the RemoveItem attributes, including the item to be removed.
Invoke the Execute function.

Public Methods

SetDescription
SetItemObjId
SetItemName
SetItemPath
SetRecursive
SetCreateOnBranch
SetCreateOnTrunk
SetBranchOut
GetDescription
GetItemObjId
GetItemName
GetItemPath
GetRecursive
GetCreateOnBranch
GetCreateOnTrunk
GetBranchOut
Execute

More information:

HSDK Programming Fundamentals
CaContext