ICCElement interface
Description
The ICCElement interface represents the DevOps Code ClearCase® element object.
Inheritance

Properties and related methods
- Group and SetGroup
Gets the group to which this element belongs
Sets the group to which this element belongs
- Master and SetMaster
Gets the master replica for this element
Sets the master replica for this element
- Owner and SetOwner
Gets the owner of this element
Sets the owner of this element
- Permissions and SetPermissions
Gets the permissions on this element
Sets the permissions on this element
Read-only properties
- CheckedOutFile
Gets the version of the element checked out to the associated view
- Component
Gets the component associated with this element
- ElementType
Gets the element type of this element
- Lock
Gets the lock on this element
- Parent
Gets the parent directory element of this element
- Trigger
Gets a named trigger that is attached to this file or directory element
- Triggers
Gets the collection of triggers that are attached to this file or directory element
- Version
Gets the particular version of this element that is specified by the version selector
- VersionByBaseline
Gets the version of this element that is selected by a specified baseline
Methods
- CreateLock
Locks this element
- Move
Moves this element to another directory; both the source directory and target directory must be checked-out
- RemoveElement
Removes irretrievably this element (equivalent to cleartool rmelem with the -force option)
- RemoveName
Removes the name of this element from its parent directory (version)
- Rename
Renames this element
Examples
Creation
You can get a CCElement object from the following interfaces:
CheckedOutFile
Gets the version of the element checked out to the associated view
Category
Read-only property
VB syntax
Property CheckedOutFile As CCCheckedOutFile
Component
Gets the component associated with this element
Category
Read-only property
VB syntax
Property Component As CCComponent
CreateLock
Locks this element
Category
Method
VB syntax
Sub CreateLock([ Comment As String = "" ], [ Obsolete As Boolean = False ], [ ExemptUsersStringArray As Variant ])
Visual C++ syntax
HRESULT CreateLock( _bstr_t Comment, VARIANT_BOOL Obsolete, const _variant_t& ExemptUsersStringArray = vtMissing);
- Parameter
- Description
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this CreateLock operation.
- Obsolete
- Optional in Visual Basic. True to make the locked element obsolete in addition to locked (like cleartool lock -obsolete); False to lock the element without making it obsolete.
- ExemptUsersStringArray
- Optional. Variant array of String values containing the names of users exempted from the lock being created.
Member of: ICCElement interface
ElementType
Gets the element type of this element
Category
Read-only property
VB syntax
Property ElementType As String
Group
Gets the group to which this element belongs
Category
Read-only property
VB syntax
Property Group As String
Visual C++ syntax
_bstr_t GetGroup();
Lock
Master
Gets the master replica for this element
Category
Read-only property
VB syntax
Property Master As String
Visual C++ syntax
_bstr_t GetMaster();
Move
Moves this element to another directory; both the source directory and target directory must be checked-out
Category
Method
VB syntax
Sub Move(pNewParent As CCElement, [ Comment As String = "" ])
Visual C++ syntax
HRESULT Move( ICCElement* pNewParent, _bstr_t Comment);
- Parameter
- Description
- pNewParent
- A path to an existing directory element, to which the element is to be moved.
- Comment
- Optional in Visual Basic. A comment to associate with the history records for the add name and remove name operations.
Owner
Gets the owner of this element
Category
Read-only property
VB syntax
Property Owner As String
Visual C++ syntax
_bstr_t GetOwner();
Parent
Gets the parent directory element of this element
Category
Read-only property
VB syntax
Property Parent As CCElement
Visual C++ syntax
ICCElementPtr GetParent();
Permissions
Gets the permissions on this element
Category
Read-only property
VB syntax
Property Permissions As Long
Visual C++ syntax
long GetPermissions();
Return value
The access mode for the element.
RemoveElement
Removes irretrievably this element (equivalent to cleartool rmelem with the -force option)
Category
Method
VB syntax
Sub RemoveElement([ Comment As String = "" ])
Visual C++ syntax
HRESULT RemoveElement(_bstr_t Comment);
- Parameter
- Description
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this RemoveElement operation.
Member of: ICCElement interface
RemoveName
Removes the name of this element from its parent directory (version)
Category
Method
VB syntax
Sub RemoveName([ Comment As String = "" ], [ DirectoryMustBeCheckedOut As Boolean = True ])
Visual C++ syntax
HRESULT RemoveName( _bstr_t Comment, VARIANT_BOOL DirectoryMustBeCheckedOut);
- Parameter
- Description
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this RemoveName operation.
- DirectoryMustBeCheckedOut
- Optional in Visual Basic. True to require that the directory that contains the name to remove is checked out prior to this operation; False to remove the name from a checked-in directory version (like cleartool rmname -nco).
Rename
Renames this element
Category
Method
VB syntax
Sub Rename(NewName As String, [ Comment As String = "" ])
Visual C++ syntax
HRESULT Rename( _bstr_t NewName, _bstr_t Comment);
- Parameter
- Description
- NewName
- The new name for this element.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this Rename operation.
Member of: ICCElement interface
SetGroup
Sets the group to which this element belongs
Category
Method
VB syntax
Sub SetGroup(NewGroup As String, [ Comment As String = "" ])
Visual C++ syntax
HRESULT SetGroup( _bstr_t NewGroup, _bstr_t Comment);
- Parameter
- Description
- NewGroup
- Name of the new group to which the element will belong.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetGroup operation.
SetMaster
Sets the master replica for this element
Category
Method
VB syntax
Sub SetMaster(Replica As String, [ Comment As String = "" ])
Visual C++ syntax
HRESULT SetMaster( _bstr_t Replica, _bstr_t Comment);
- Parameter
- Description
- Replica
- Name of the replica to which mastership of the element is being transferred.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetMaster operation.
SetOwner
Sets the owner of this element
Category
Method
VB syntax
Sub SetOwner(NewOwner As String, [ Comment As String = "" ])
Visual C++ syntax
HRESULT SetOwner( _bstr_t NewOwner, _bstr_t Comment);
- Parameter
- Description
- NewOwner
- Name of the owner to whom ownership of the element is being transferred.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetOwner operation.
SetPermissions
Sets the permissions on this element
Category
Method
VB syntax
Sub SetPermissions(NewPermissions As Long, [ Comment As String = "" ])
Visual C++ syntax
HRESULT SetPermissions( long NewPermissions, _bstr_t Comment);
- Parameter
- Description
- NewPermissions
- The access mode specified in octal for the element.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetPermissions operation.
Trigger
Gets a named trigger that is attached to this file or directory element
Category
Read-only property
VB syntax
Property Trigger(TriggerType As String) As CCTrigger
Visual C++ syntax
ICCTriggerPtr GetTrigger( _bstr_t TriggerType);
- Parameter
- Description
- TriggerType
- Name of the trigger type.
Member of: ICCElement interface
Triggers
Gets the collection of triggers that are attached to this file or directory element
Category
Read-only property
VB syntax
Property Triggers As CCTriggers
Version
Gets the particular version of this element that is specified by the version selector
Category
Read-only property
VB syntax
Property Version([ Selector As String = "" ]) As CCVersion
Visual C++ syntax
ICCVersionPtr GetVersion( _bstr_t Selector);
- Parameter
- Description
- Selector
- Optional in Visual Basic. An identifier that specifies the branch or branches and version number for the version. If Selector is not specified, gets the version that is selected by this view.
Member of: ICCElement interface
VersionByBaseline
Gets the version of this element that is selected by a specified baseline
It checks whether the element is in the same component as the baseline. If the specified baseline is not in the same component as the element, the error message is Element is not in the same component as the baseline.
Category
Read-only property
VB syntax
Property VersionByBaseline(Baseline As CCBaseline) As CCVersion
Visual C++ syntax
ICCVersionPtr GetVersionByBaseline(ICCBaseline* Baseline);
- Parameter
- Description
- Baseline
- Baseline in which the version to be returned is selected.
Member of: ICCElement interface