ICCVOB interface

Description

The ICCVOB interface represents the Rational® ClearCase® VOB object.

Inheritance

ICCVOB inherits from
ICCVOBObject, which inherits from IDispatch. The descendants of ICCVOB is
ICCProjectVOB. ICCVOBObject interface ICCProjectVOB interface

Properties and related methods

Master and SetMaster

Gets the master replica for the replica of this VOB

Sets the master replica for the replica of this VOB

Read-write properties

IsMounted

Gets and sets whether the VOB is mounted

Read-only properties

Activity

Gets the activity that this activity selector identifies

AdditionalGroupsStringArray

Gets the array of the supplementary groups of the VOB

AttributeType

Gets an existing attribute type

AttributeTypes

Gets all existing attribute types in the VOB

BranchType

Gets an existing branch type

BranchTypes

Gets all existing branch types in the VOB

Group

Gets the group to which this VOB belongs

HasMSDOSTextMode

Gets whether this VOB has MSDOS text mode enabled

Host

Gets the host on which the storage area for this VOB resides

Hyperlink
HyperlinkType

Gets an existing hyperlink type

HyperlinkTypes

Gets all existing hyperlink types in this VOB

IsReplicated

Gets whether this VOB is replicated

LabelType

Gets an existing label type

LabelTypes

Gets all existing label types in this VOB

Lock

Gets the lock on this VOB, or fails if none

Locks

Gets a collection of all the locks in this VOB

NumberOfAdditionalGroups

Gets the number of supplementary groups for this VOB

NumberOfReplicas

Gets the number of replica names for the VOB family of this VOB, if this VOB is replicated

Owner

Gets the owner of the VOB

ReplicasStringArray

Gets the array of replica names for the VOB family of this VOB, if this VOB is replicated

TagName (default property)

Gets the VOB tag name

ThisReplica

Gets the replica name for this VOB, if the VOB is replicated

TriggerType

Gets an existing trigger type

TriggerTypes

Gets all existing trigger types in this VOB

Write-only properties

IsPersistent

Sets whether the VOB is mounted persistently (mounted automatically after a reboot)

Methods

CreateAttributeType

Creates a new attribute type

CreateBranchType

Creates a new branch type

CreateHyperlinkType

Creates a new hyperlink type

CreateLabelType

Creates a new label type

CreateLock

Locks this VOB

CreateTriggerTypeBuilder

Gets an empty trigger type builder for the creation of a new trigger type

Protect

Sets the ownership and group information for this VOB

Examples

Creation

Activity

Gets the activity that this activity selector identifies

Category

Read-only property

VB syntax

Property Activity(Selector As String) As CCActivity

Visual C++ syntax

ICCActivityPtr GetActivity(_bstr_t Selector);
Parameter
Description
Selector
An identifier of the form [activity:]activity-name[@vob-selector] to specify the activity. vob-selector is optional, but if specified must match the project VOB represented by the CCVOB object.

Member of: ICCVOB interface

AdditionalGroupsStringArray

Gets the array of the supplementary groups of the VOB

Category

Read-only property

VB syntax

Property AdditionalGroupsStringArray As Variant

Visual C++ syntax

_variant_t GetAdditionalGroupsStringArray();

Return value

An array of Variants that contains String values which represent the names of the VOB's supplementary groups.

AttributeType

Gets all existing attribute types in the VOB

Category

Read-only property

VB syntax

Property AttributeType(Name As String, [ Local As Boolean = False ]) As CCAttributeType

Visual C++ syntax

ICCAttributeTypePtr GetAttributeType(
     _bstr_t Name,
     VARIANT_BOOL Local);
Parameter
Description
Name
Name of the new attribute type.
Local
Optional in Visual Basic. Specifies that the attribute type name is looked up only in the VOB represented by this object and not in any administrative VOBs.

Member of: ICCVOB interface

AttributeTypes

Gets all existing attribute types in the VOB

Category

Read-only property

VB syntax

Property AttributeTypes([ Local As Boolean = False ], [ IncludeObsoletes As Boolean = False ]) As CCAttributeTypes

Visual C++ syntax

ICCAttributeTypesPtr GetAttributeTypes(
     VARIANT_BOOL Local,
     VARIANT_BOOL IncludeObsoletes);
Parameter
Description
Local
Optional in Visual Basic. Specifies that the attribute type name is looked up only in the VOB represented by this object and not in any administrative VOBs.
IncludeObsoletes
Optional in Visual Basic. True to include obsolete attribute types in the collection; False to not include obsolete types.

Member of: ICCVOB interface

BranchType

Gets an existing branch type

Category

Read-only property

VB syntax

Property BranchType(Name As String, [ Local As Boolean = False ]) As CCBranchType

Visual C++ syntax

ICCBranchTypePtr GetBranchType(
     _bstr_t Name,
     VARIANT_BOOL Local);
Parameter
Description
Name
Name of the new branch type.
Local
Optional in Visual Basic. Specifies that the branch type name is looked up only in the VOB that is represented by this object and not in any administrative VOBs.

Member of: ICCVOB interface

BranchTypes

Gets all existing branch types in the VOB

Category

Read-only property

VB syntax

Property BranchTypes([ Local As Boolean = False ], [ IncludeObsoletes As Boolean = False ]) As CCBranchTypes

Visual C++ syntax

ICCBranchTypesPtr GetBranchTypes(
     VARIANT_BOOL Local,
     VARIANT_BOOL IncludeObsoletes);
Parameter
Description
Local
Optional in Visual Basic. Specifies that the branch type name is looked up only in the VOB represented by this object and not in any administrative VOBs.
IncludeObsoletes
Optional in Visual Basic. True to include obsolete branch types in the collection; False to not include obsolete types.

Member of: ICCVOB interface

CreateAttributeType

Creates a new attribute type

Category

Method

VB syntax

Function CreateAttributeType(Name As String, [ ValueType As Long = vbString ], [ Comment As String = "" ], [ Shared As Boolean = False ], [ Constraint As CCTypeConstraint = ccConstraint_None ], [ Global As Boolean = False ], [ Acquire As Boolean = False ]) As CCAttributeType

Visual C++ syntax

ICCAttributeTypePtr CreateAttributeType(
     _bstr_t Name,
     long ValueType,
     _bstr_t Comment,
     VARIANT_BOOL Shared,
     CCTypeConstraint Constraint,
     VARIANT_BOOL Global,
     VARIANT_BOOL Acquire);
Parameter
Description
Name
Name of the new attribute type.
ValueType
Optional in Visual Basic. Must be one of the valid value type constants.
Comment
Optional in Visual Basic. A comment to associate with the history record for this CreateAttributeType operation.
Shared
Optional in Visual Basic. True if attribute type can be shared across all replicas in a VOB family; False if attribute type can be mastered only by one replica.
Constraint
Optional in Visual Basic. Instance restriction for the attribute type. Must be one of the valid CCTypeConstraint values.
Global
Optional in Visual Basic. True to make this attribute type global to all client VOBs of this administrative VOB; False to make this attribute type an ordinary type for use only within this VOB.
Acquire
Optional in Visual Basic. True to convert existing ordinary types that would be eclipsed by this operation into local copies of this global attribute 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.)

Remarks

To create an attribute type with an enumerated value type, first use CreateAttributeType and then use ICCAttributeType::SetEnumValuesArray to specify valid enumerated values. You can also set the attribute type's lower and upper values through the ICCAttributeType interface.

Member of: ICCVOB interface

CreateBranchType

Creates a new branch type

Category

Method

VB syntax

FunctionCreateBranchType(Name As String, [ Comment As String = "" ] , [ Constraint As CCTypeConstraint = ccConstraint_PerElement ], [ Global As Boolean = False ], [ Acquire As Boolean = False ]) As CCBranchType

Visual C++ syntax

ICCBranchTypePtr CreateBranchType(
     _bstr_t Name,
     _bstr_t Comment,
     CCTypeConstraint Constraint,
     VARIANT_BOOL Global,
     VARIANT_BOOL Acquire);
Parameter
Description
Name
Name of the new branch type.
Comment
Optional in Visual Basic. A comment to associate with the history record for this CreateBranchType operation.
Constraint
Optional in Visual Basic. Instance restriction for the branch type. Must be one of the valid CCTypeConstraint values.
Global
Optional in Visual Basic. True to make this branch type global to all client VOBs of this administrative VOB; False to make this branch type an ordinary type for use only within this VOB.
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.)

Member of: ICCVOB interface

CreateHyperlinkType

Creates a new hyperlink type

Category

Method

VB syntax

Function CreateHyperlinkType(Name As String, [ Comment As String = "" ], [ Shared As Boolean = False ], [ Global As Boolean = False ], [ Acquire As Boolean = False ]) As CCHyperlinkType

Visual C++ syntax

ICCHyperlinkPtr CreateHyperlinkType(
     _bstr_t Name,
     _bstr_t Comment,
     VARIANT_BOOL Shared,
     VARIANT_BOOL Global,
     VARIANT_BOOL Acquire);
Parameter
Description
Name
Name of the new hyperlink type.
Comment
Optional in Visual Basic. A comment to associate with the history record for this CreateHyperlinkType operation.
Shared
Optional in Visual Basic. True if hyperlink type can be shared across all replicas in a VOB family; False if hyperlink type can be mastered only by one replica.
Global
Optional in Visual Basic. True to make this hyperlink type global to all client VOBs of this administrative VOB; False to make this hyperlink type an ordinary type for use only within this VOB.
Acquire
Optional in Visual Basic. True to convert existing ordinary types that would be eclipsed by this operation into local copies of this global hyperlink 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.)

Member of: ICCVOB interface

CreateLabelType

Creates a new label type

Category

Method

VB syntax

Function CreateLabelType(Name As String, [ Comment As String = "" ],[ Shared As Boolean = False ], [ Constraint As CCTypeConstraint = ccConstraint_PerElement ], [ Global As Boolean = False ], [ Acquire As Boolean ]) As CCLabelType

Visual C++ syntax

ICCLabelTypePtr CreateLabelType(
     _bstr_t Name,
     _bstr_t Comment,
     VARIANT_BOOL Shared,
     CCTypeConstraint Constraint,
     VARIANT_BOOL Global,
     VARIANT_BOOL Acquire);
Parameter
Description
Name
Name of the new label type.
Comment
Optional in Visual Basic. A comment to associate with the history record for this CreateLabelType operation.
Shared
Optional in Visual Basic. True if label type can be shared across all replicas in a VOB family; False if label type can be mastered only by one replica.
Constraint
Optional in Visual Basic. Instance restriction for the label type. Must be one of the valid CCTypeConstraint values.
Global
Optional in Visual Basic. True to make this label type global to all client VOBs of this administrative VOB; False to make this label type an ordinary type for use only within this VOB.
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.)

Member of: ICCVOB interface

CreateLock

Locks this VOB

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 VOB obsolete in addition to locked (like cleartool lock -obsolete); False to lock the VOB without making it obsolete.
ExemptUsersStringArray
Optional. A Variant array of String values containing the names of users exempted from the lock being created.

See Also

Lock

Member of: ICCVOB interface

CreateTriggerTypeBuilder

Gets an empty trigger type builder for the creation of a new trigger type

Category

Method

VB syntax

Function CreateTriggerTypeBuilder As CCTriggerTypeBuilder

Visual C++ syntax

ICCTriggerTypeBuilderPtr Create TriggerTypeBuilder();

Member of: ICCVOB interface

Group

Gets the group to which this VOB belongs

Category

Read-only property

VB syntax

Property Group As String

Visual C++ syntax

_bstr_t GetGroup();

See also

Protect

Member of: ICCVOB interface

HasMSDOSTextMode

Gets whether this VOB has MSDOS text mode enabled

Category

Read-only property

VB syntax

Property HasMSDOSTextMode As Boolean

Visual C++ syntax

VARIANT_BOOL GetHasMSDOSTextMode();

Remarks

This can be a very expensive operation because it must contact the VOB server to get the text mode information. It may not be the kind of operation to perform for every VOB in a region, for example. This is especially true if you know that attempts to contact some of the VOB servers will be unsuccessful.

Member of: ICCVOB interface

Host

Gets the host on which the storage area for this VOB resides

Category

Read-only property

VB syntax

Property Host As String

Visual C++ syntax

_bstr_t GetHost();

Member of: ICCVOB interface

HyperlinkType

Gets an existing hyperlink type

Category

Read-only property

VB syntax

Property HyperlinkType(Name As String, [ Local As Boolean = False ]) As CCHyperlinkType

Visual C++ syntax

ICCHyperlinkTypePtr GetHyperlinkType(
     _bstr_t Name
     VARIANT_BOOL Local);
Parameter
Description
Name
Name of the hyperlink type.
Local
Optional in Visual Basic. Specifies that the hyperlink type name is looked up only in the VOB that is represented by this object and not in any administrative VOBs.

Member of: ICCVOB interface

HyperlinkTypes

Gets all existing hyperlink types in this VOB

Category

Read-only property

VB syntax

Property HyperlinkTypes([ Local As Boolean = False ], [ IncludeObsoletes As Boolean = False ]) As CCHyperlinkTypes

Visual C++ syntax

ICCHyperlinkTypesPtr GetHyperlinkTypes(
     VARIANT_BOOL Local,
     VARIANT_BOOL IncludeObsoletes);
Parameter
Description
Local
Optional in Visual Basic. Specifies that the hyperlink type name is looked up only in the VOB represented by this object and not in any administrative VOBs.
IncludeObsoletes
Optional in Visual Basic. True to include obsolete hyperlink types in the collection; False to not include obsolete types.

Member of: ICCVOB interface

IsMounted

Gets and sets whether the VOB is mounted

Category

Read-write property

VB syntax

Property IsMounted As Boolean

Visual C++ syntax

VARIANT_BOOL GetIsMounted();
void PutIsMounted(VARIANT_BOOL NewIsMounted);
Parameter
Description
NewIsMounted
Visual C++ only. Specify True to mount the VOB; False not to mount the VOB.

Remarks

Setting this property only applies to Rational ClearCase installations that have the multi-version file system (MVFS). The VOB being activated must already have a VOB tag for your host's network region in the Rational ClearCase registry.

Member of: ICCVOB interface

IsPersistent

Sets whether the VOB is mounted persistently (mounted automatically after a reboot)

Category

Write-only property

VB syntax

Property IsPersistent As Boolean

Visual C++ syntax

void PutIsPersistent(VARIANT_BOOL NewIsPersistent);
Parameter
Description
NewIsPersistent
Visual C++ only. Specify True to mount the VOB persistently; False not to mount the VOB persistently.

Remarks

Setting this property only applies to Rational ClearCase installations that have the MVFS.

Member of: ICCVOB interface

IsReplicated

Gets whether this VOB is replicated

Category

Read-only property

VB syntax

Property IsReplicated As Boolean

Visual C++ syntax

VARIANT_BOOL GetIsReplicated();

LabelType

Gets an existing label type

Category

Read-only property

VB syntax

Property LabelType(Name As String, [ Local As Boolean = False ]) As CCLabelType

Visual C++ syntax

ICCLabelTypePtr GetLabelType(
     _bstr_t Name,
     VARIANT_BOOL Local);
Parameter
Description
Name
Name of the label type.
Local
Optional in Visual Basic. Specifies that the label type name is looked up only in the VOB represented by this object and not in any administrative VOBs.

Member of: ICCVOB interface

LabelTypes

Gets all existing label types in this VOB

Category

Read-only property

VB syntax

Property LabelTypes([ Local As Boolean = False ], [ IncludeObsoletes As Boolean = False ]) As CCLabelTypes

Visual C++ syntax

ICCLabelTypesPtr GetLabelTypes(
     VARIANT_BOOLLocal,
     VARIANT_BOOL IncludeObsoletes);
Parameter
Description
Local
Optional in Visual Basic. Specifies that the branch type name is looked up only in the VOB represented by this object and not in any administrative VOBs.
IncludeObsoletes
Optional in Visual Basic. True to include obsolete label types in the collection; False to not include obsolete types.

Member of: ICCVOB interface

Lock

Gets the lock on this VOB, or fails if none

Category

Read-only property

VB syntax

Property Lock As CCLock

Visual C++ syntax

ICCLockPtr GetLock();

See also

CreateLock

Member of: ICCVOB interface

Locks

Gets a collection of all the locks in this VOB

Category

Read-only property

VB syntax

Property Locks([ IncludeObsoletes As Boolean = False ]) As CCLocks

Visual C++ syntax

ICCLocksPtr GetLocks(VARIANT_BOOLIncludeObsoletes);
Parameter
Description
IncludeObsoletes
Optional in Visual Basic. True to include obsolete types in the collection; False to not include obsolete types.

Member of: ICCVOB interface

Master

Gets the master replica for the replica of this VOB

Category

Read-only property

VB syntax

Property Master As String

Visual C++ syntax

_bstr_t GetMaster();

See also

SetMaster

Member of: ICCVOB interface

NumberOfAdditionalGroups

Gets the number of supplementary groups for this VOB

Category

Read-only property

VB syntax

Property NumberOfAdditionalGroups As Long

Visual C++ syntax

long GetNumberOfAdditionalGroups();

NumberOfReplicas

Gets the number of replica names for the VOB family of this VOB, if this VOB is replicated

Category

Read-only property

VB syntax

Property NumberOfReplicas As Long

Visual C++ syntax

long GetNumberOfReplicas();

Owner

Gets the owner of the VOB

Category

Read-only property

VB syntax

Property Owner As String

Visual C++ syntax

_bstr_t GetOwner();

See also

Protect

Member of: ICCVOB interface

Protect

Sets the ownership and group information for this VOB

Category

Method

VB syntax

Sub Protect([ NewOwner As String = "" ], [ NewGroup As String = "" ], [ GroupsToAddStringArray As Variant ], [ GroupsToRemoveStringArray As Variant ])

Visual C++ syntax

HRESULT Protect(
     _bstr_t NewOwner,
     _str_t NewGroup,
     const _variant_t& GroupsToAddStringArray = vtMissing,
     const _variant_t& GroupsToRemoveStringArray = vtMissing);
Parameter
Description
NewOwner
Optional in Visual Basic. The name of the owner to which ownership of the VOB is being transferred.
NewGroup
Optional in Visual Basic. The name of the new group to which this VOB belongs.
GroupsToAddStringArray
Optional. An array of Variants containing String values representing the names of groups to be added to the VOB's supplementary groups.
GroupsToRemoveStringArray
Optional. An array of Variants containing String values representing the names of groups to be removed from the VOB's supplementary groups.

ReplicasStringArray

Gets the array of replica names for the VOB family of this VOB, if this VOB is replicated

Category

Read-only property

VB syntax

Property ReplicasStringArray As Variant

Visual C++ syntax

_variant_t GetReplicasStringArray();

Return value

An array of Variants that contains String values which represent the names of VOB replicas.

SetMaster

Sets the master replica for the replica of this VOB

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 VOB's replica is being transferred.
Comment
Optional in Visual Basic. A comment to associate with the history record for this SetMaster operation.

See also

Master

Member of: ICCVOB interface

TagName

Gets the VOB tag name

Category

Read-only property

VB syntax

Property TagName As String

Visual C++ syntax

_bstr_t GetTagName();

Member of: ICCVOB interface

ThisReplica

Gets the replica name for this VOB, if the VOB is replicated

Category

Read-only property

VB syntax

Property ThisReplica As String

Visual C++ syntax

_bstr_t GetThisReplica();

Member of: ICCVOB interface

TriggerType

Gets an existing trigger type

Category

Read-only property

VB syntax

Property TriggerType(Name As String) As CCTriggerType

Visual C++ syntax

ICCTriggerTypePtr GetTriggerType(_bstr_t Name);
Parameter
Description
Name
The name of the trigger type.

Member of: ICCVOB interface

TriggerTypes

Gets all existing trigger types in this VOB

Category

Read-only property

VB syntax

Property TriggerTypes([ IncludeObsoletes As Boolean = False ]) As CCTriggerTypes

Visual C++ syntax

ICCTriggerTypesPtr GetTriggerTypes(VARIANT_BOOL IncludeObsoletes);
Parameter
Description
IncludeObsoletes
Optional. True to include obsolete trigger types in the collection; False to not include obsolete types.

Member of: ICCVOB interface


Feedback