ICCBranchType interface
Description
The ICCBranchType interface represents the DevOps Code ClearCase® branch type object.
Every branch is an instance of a kind of branch type. In general, the meaning associated with a particular branch type is user-defined. (Some pre-defined kinds of branch types have meaning to DevOps Code ClearCase itself and are used as part of the implementation of DevOps Code ClearCase.)
Inheritance

Properties and related methods
- Constraint/SetConstraint
- Gets and sets the constraint for this branch type
- Group/SetGroup
- Gets and sets the group to which this branch type belongs
- Master/SetMaster
- Gets and sets the master replica for this branch type
- Name (default property) /Set Name
- Gets and sets the name of this branch type
- Owner/SetOwner
- Gets and sets the owner of this branch type
- Scope/SetScope
- Gets and sets the scope of this branch type (for example, local to this VOB)
Read-only properties
Methods:
- Apply
- Creates an instance of this branch type (a branch) sprouting from the specified version and checks out the branch
- ApplyNoCheckOut
- Creates an instance of this branch type (a branch) sprouting from the specified version without checking out the branch
- CreateLock
- Locks this branch type
- RemoveType
- Removes this branch type from the VOB
Examples
Creation
You can get a CCBranchType object from the following interfaces:
Apply
Creates an instance of this branch type (a branch) sprouting from the specified version and checks out the branch
Category
Method
VB syntax
Function Apply(pVersion As CCVersion, [Comment As String = "" ]) As CCCheckedOutFile
Visual C++ syntax
ICCCheckedOutFilePtr Apply( ICCVersion* pVersion, _bstr_t Comment);
- Parameter
- Description
- pVersion
- Version to which the branch will be applied.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this Apply operation.
Return value
The checked-out branch.
ApplyNoCheckOut
Creates an instance of this branch type (a branch) sprouting from the specified version without checking out the branch
Category
Method
VB syntax
Sub ApplyNoCheckOut(pVersion As CCVersion, [ CommentAs String = "" ])
Visual C++ syntax
HRESULT ApplyNoCheckOut( ICCVersion* pVersion, _bstr_t Comment);
- Parameter
- Description
- pVersion
- Version to which the branch will be applied.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this ApplyNoCheckOut operation.
Member of: ICCBranchType Interface
Constraint
Gets the constraint for this branch type (for example, one per element)
Category
Read-Only Property
VB syntax
Property Constraint As CCTypeConstraint
Visual C++ syntax
CCTypeConstraint GetConstraint();
Return value
A CCTypeConstraint value.
CreateLock
Locks this branch 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 branch type obsolete in addition to locked (like cleartool lock -obsolete);False to lock the branch 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 branch type belongs
Category
Read-Only Property
VB syntax
Property Group As String
Visual C++ syntax
_bstr_t GetGroup();
Lock
Gets the lock on this branch type
Category
Read-Only Property
VB syntax
Property Lock As CCLock
Visual C++ syntax
ICCLockPtr GetLock();
Master
Gets the master replica for this branch 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 branch type.
Name
Gets the name of the branch type
Category
Read-Only Property
VB syntax
Property Name As String
Visual C++ syntax
_bstr_t GetName();
Owner
Gets the owner of this branch type
Category
Read-Only Property
VB syntax
Property Owner As String
Visual C++ syntax
_bstr_t GetOwner();
RemoveType
Removes this branch type from 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 branch type and all instances of the type; False to remove the branch 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: ICCBranchType Interface
Scope
Gets the scope of this branch type (for example, 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 branch type (for example, one per element)
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 branch 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 branch 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 branch 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 branch 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 branch 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 branch type.
SetName
Changes the name of this branch type and all instances of the branch 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 branch type.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetName operation.
SetOwner
Sets the owner of this branch 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 branch type is being transferred.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetOwner operation.
SetScope
Sets the scope of this branch type (for example, 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 branch type global; Global types are accessible to all VOBs using as an administrative VOB the VOB containing the type. False to make this branch 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 branch 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.