ICCLabelType interface
Description
The ICCLabelType interface represents the DevOps Code ClearCase® label type object.
Every label is an instance of a kind of label type. In general, the meaning that is associated with a particular label type is user-defined.
Inheritance

Properties and related methods
- Constraint and SetConstraint
Gets the constraint for this label type
Sets the constraint for this label type (for example, one per branch)
- Group and SetGroup
Gets the group to which this label type belongs
Sets the group to which this label type belongs
- HasSharedMastership and ShareMastership
- Master and SetMaster
Gets the master replica for this label type
Sets the master replica for this label type
- Name (default property) and SetName
Gets the name of this label type
Changes the name of this label type and all instances of the label type
- Owner and SetOwner
Gets the owner of this label type
Sets the owner of this label type
- Scope and SetScope
Gets whether label type is global for VOBs using this as an admin VOB or local to this VOB
Sets whether label type is global for VOBs using this as an admin VOB or local to this VOB
Read-only properties
Methods
- Apply
Applies an instance of this label type to a version object
- CreateLock
Locks this label type
- RemoveType
Removes this label type from the VOB
Examples
Creation
Apply
Applies an instance of this label type to a version object
Category
Method
VB syntax
Sub Apply(pVersion As CCVersion, [ Comment As String = "" ],[ Replace As Boolean = False ], [ Recurse as Boolean = False ])
Visual C++ syntax
HRESULT Apply( ICCVersion* pVersion, _bstr_t Comment, VARIANT_BOOL Replace, VARIANT_BOOL Recurse);
- Parameter
- Description
- pVersion
- The version to which the label will be applied.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this Apply operation.
- Replace
- Optional in Visual Basic. True to remove labels of this type from other versions of this element; False to fail if the label is already applied to another version.
- Recurse
- Optional in Visual Basic. True to process the entire subtree below any directory element encountered; False to process only the directory element itself, or a file.
Member of: ICCLabelType interface
Constraint
Gets the constraint for this label type
Category
Read-only property
VB syntax
Property Constraint As CCTypeConstraint
Visual C++ syntax
CCTypeConstraint GetConstraint();
Return value
A CCTypeConstraint value.
CreateLock
Locks this label type
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 label type obsolete in addition to locked (like cleartool lock -obsolete); False to lock the label type without making it obsolete.
- ExemptUsersStringArray
- Optional. Variant array of String values containing the names of users exempted from the lock being created.
Group
Gets the group to which this label type belongs
Category
Read-only property
VB syntax
Property Group As String
Visual C++ syntax
_bstr_t GetGroup();
Lock
Gets the lock on this label type
Category
Read-only property
VB syntax
Property Lock As CCLock
Visual C++ syntax
ICCLockPtr GetLock();
Master
Gets the master replica for this label type
Category
Read-only property
VB syntax
Property Master As String
Visual C++ syntax
_bstr_t GetMaster();
Remarks
It is most likely that you want to operate on the local copy of the label type.
Name
Gets the name of this label type
Category
Read-only property
VB syntax
Property Name As String
Visual C++ syntax
_bstr_t GetName();
Owner
Gets the owner of this label type
Category
Read-only property
VB syntax
Property Owner As String
Visual C++ syntax
_bstr_t GetOwner();
RemoveType
Removes this label type from the VOB
Category
Method
VB syntax
Sub RemoveType([ RemoveAllInstances As Boolean = False ], [ Comment As String = "" ])
Visual C++ syntax
HRESULT RemoveType( VARIANT_BOOL RemoveAllInstances, _bstr_t Comment);
- Parameter
- Description
- RemoveAllInstances
- Optional in Visual Basic. True to remove the label type and all instances of the type; False to remove the label type only if there are no instances of the type.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this RemoveType operation.
Member of: ICCLabelType interface
Scope
Gets whether label type is global for VOBs using this as an admin VOB or local to this VOB
Category
Read-only property
VB syntax
Property Scope As CCTypeScope
Visual C++ syntax
CCTypeScope GetScope();
Return value
A CCTypeScope value.
SetConstraint
Sets the constraint for this label type (for example, one per branch)
Category
Method
VB syntax
Sub SetConstraint(NewConstraint As CCTypeConstraint, [ Comment As String = "" ])
Visual C++ syntax
HRESULT SetConstraint( CCTypeConstraint NewConstraint, _bstr_t Comment);
- Parameter
- Description
- NewConstraint
- Instance restriction for the label type. Must be one of the valid CCTypeConstraint values.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetConstraint operation.
SetGroup
Sets the group to which this label type 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 label type 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 label type
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 label type is being transferred.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetMaster operation.
Remarks
It is most likely that you want to operate on the local copy of the label type.
SetName
Changes the name of this label type and all instances of the label type
Category
Method
VB syntax
Sub SetName(NewName As String, [ Comment As String = "" ])
Visual C++ syntax
HRESULT SetName( _bstr_t NewName, _bstr_t Comment);
- Parameter
- Description
- NewName
- The new name for this label type.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetName operation.
SetOwner
Sets the owner of this label type
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 which ownership of the label type is being transferred.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetOwner operation.
SetScope
Sets whether label type is global for VOBs using this as an admin VOB or local to this VOB
Category
Method
VB syntax
Sub SetScope(Global As Boolean, [ Acquire As Boolean = False ], [ Comment As String = "" ])
Visual C++ syntax
HRESULT SetScope( VARIANT_BOOL Global, VARIANT_BOOL Acquire, _bstr_t Comment);
- Parameter
- Description
- Global
- True to make this label type global. Global types are accessible to all VOBs using as an administrative VOB the VOB containing the type. False to make this label type an ordinary type for use only within the VOB that contains it.
- Acquire
- Optional in Visual Basic. True to convert existing ordinary types that would be eclipsed by this operation into local copies of this global label type (only allowed if Global is True); False to fail if any existing types would be eclipsed. (An eclipsed type is one that has the same name as the global type in its administrative VOB.)
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetScope operation.
VOB
Gets the VOB that contains this label type
Category
Read-only property
VB syntax
Property VOB As CCVOB