The ICCVOB interface represents the Rational® ClearCase® VOB object.
Gets the host on which the storage area for this VOB resides
Gets the number of replica names for the VOB family of this VOB, if this VOB is replicated
Gets the array of replica names for the VOB family of this VOB, if this VOB is replicated
Gets the replica name for this VOB, if the VOB is replicated
Sets whether the VOB is mounted persistently (mounted automatically after a reboot)
Gets an empty trigger type builder for the creation of a new trigger type
Gets the activity that this activity selector identifies
Read-only property
Property Activity(Selector As String) As CCActivity
ICCActivityPtr GetActivity(_bstr_t Selector);
Member of: ICCVOB interface
Gets the array of the supplementary groups of the VOB
Read-only property
Property AdditionalGroupsStringArray As Variant
_variant_t GetAdditionalGroupsStringArray();
An array of Variants that contains String values which represent the names of the VOB's supplementary groups.
Gets all existing attribute types in the VOB
Read-only property
Property AttributeType(Name As String, [ Local As Boolean = False ]) As CCAttributeType
ICCAttributeTypePtr GetAttributeType( _bstr_t Name, VARIANT_BOOL Local);
Member of: ICCVOB interface
Gets all existing attribute types in the VOB
Read-only property
Property AttributeTypes([ Local As Boolean = False ], [ IncludeObsoletes As Boolean = False ]) As CCAttributeTypes
ICCAttributeTypesPtr GetAttributeTypes( VARIANT_BOOL Local, VARIANT_BOOL IncludeObsoletes);
Member of: ICCVOB interface
Gets an existing branch type
Read-only property
Property BranchType(Name As String, [ Local As Boolean = False ]) As CCBranchType
ICCBranchTypePtr GetBranchType( _bstr_t Name, VARIANT_BOOL Local);
Member of: ICCVOB interface
Gets all existing branch types in the VOB
Read-only property
Property BranchTypes([ Local As Boolean = False ], [ IncludeObsoletes As Boolean = False ]) As CCBranchTypes
ICCBranchTypesPtr GetBranchTypes( VARIANT_BOOL Local, VARIANT_BOOL IncludeObsoletes);
Member of: ICCVOB interface
Creates a new attribute type
Method
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
ICCAttributeTypePtr CreateAttributeType( _bstr_t Name, long ValueType, _bstr_t Comment, VARIANT_BOOL Shared, CCTypeConstraint Constraint, VARIANT_BOOL Global, VARIANT_BOOL Acquire);
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
Creates a new branch type
Method
FunctionCreateBranchType(Name As String, [ Comment As String = "" ] , [ Constraint As CCTypeConstraint = ccConstraint_PerElement ], [ Global As Boolean = False ], [ Acquire As Boolean = False ]) As CCBranchType
ICCBranchTypePtr CreateBranchType( _bstr_t Name, _bstr_t Comment, CCTypeConstraint Constraint, VARIANT_BOOL Global, VARIANT_BOOL Acquire);
Member of: ICCVOB interface
Creates a new hyperlink type
Method
Function CreateHyperlinkType(Name As String, [ Comment As String = "" ], [ Shared As Boolean = False ], [ Global As Boolean = False ], [ Acquire As Boolean = False ]) As CCHyperlinkType
ICCHyperlinkPtr CreateHyperlinkType( _bstr_t Name, _bstr_t Comment, VARIANT_BOOL Shared, VARIANT_BOOL Global, VARIANT_BOOL Acquire);
Member of: ICCVOB interface
Creates a new label type
Method
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
ICCLabelTypePtr CreateLabelType( _bstr_t Name, _bstr_t Comment, VARIANT_BOOL Shared, CCTypeConstraint Constraint, VARIANT_BOOL Global, VARIANT_BOOL Acquire);
Member of: ICCVOB interface
Locks this VOB
Method
Sub CreateLock([ Comment As String = "" ], [ Obsolete As Boolean = False ], [ ExemptUsersStringArray As Variant ])
HRESULT CreateLock( _bstr_t Comment, VARIANT_BOOL Obsolete, const _variant_t& ExemptUsersStringArray = vtMissing);
Gets an empty trigger type builder for the creation of a new trigger type
Method
Function CreateTriggerTypeBuilder As CCTriggerTypeBuilder
Gets the group to which this VOB belongs
Read-only property
Property Group As String
_bstr_t GetGroup();
Gets whether this VOB has MSDOS text mode enabled
Read-only property
Property HasMSDOSTextMode As Boolean
VARIANT_BOOL GetHasMSDOSTextMode();
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
Gets the host on which the storage area for this VOB resides
Read-only property
Property Host As String
Gets the specified hyperlink
Read-only property
Property Hyperlink(IDString As String) As CCHyperlink
ICCHyperlinkPtr GetHyperlink(_bstr_t IDString);
Member of: ICCVOB interface
Gets an existing hyperlink type
Read-only property
Property HyperlinkType(Name As String, [ Local As Boolean = False ]) As CCHyperlinkType
ICCHyperlinkTypePtr GetHyperlinkType( _bstr_t Name VARIANT_BOOL Local);
Member of: ICCVOB interface
Gets all existing hyperlink types in this VOB
Read-only property
Property HyperlinkTypes([ Local As Boolean = False ], [ IncludeObsoletes As Boolean = False ]) As CCHyperlinkTypes
ICCHyperlinkTypesPtr GetHyperlinkTypes( VARIANT_BOOL Local, VARIANT_BOOL IncludeObsoletes);
Member of: ICCVOB interface
Gets and sets whether the VOB is mounted
Read-write property
Property IsMounted As Boolean
VARIANT_BOOL GetIsMounted(); void PutIsMounted(VARIANT_BOOL NewIsMounted);
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
Sets whether the VOB is mounted persistently (mounted automatically after a reboot)
Write-only property
Property IsPersistent As Boolean
void PutIsPersistent(VARIANT_BOOL NewIsPersistent);
Setting this property only applies to Rational ClearCase installations that have the MVFS.
Member of: ICCVOB interface
Gets whether this VOB is replicated
Read-only property
Property IsReplicated As Boolean
VARIANT_BOOL GetIsReplicated();
Gets an existing label type
Read-only property
Property LabelType(Name As String, [ Local As Boolean = False ]) As CCLabelType
ICCLabelTypePtr GetLabelType( _bstr_t Name, VARIANT_BOOL Local);
Member of: ICCVOB interface
Gets all existing label types in this VOB
Read-only property
Property LabelTypes([ Local As Boolean = False ], [ IncludeObsoletes As Boolean = False ]) As CCLabelTypes
ICCLabelTypesPtr GetLabelTypes( VARIANT_BOOLLocal, VARIANT_BOOL IncludeObsoletes);
Member of: ICCVOB interface
Gets the lock on this VOB, or fails if none
Read-only property
Property Lock As CCLock
ICCLockPtr GetLock();
Gets a collection of all the locks in this VOB
Read-only property
Property Locks([ IncludeObsoletes As Boolean = False ]) As CCLocks
ICCLocksPtr GetLocks(VARIANT_BOOLIncludeObsoletes);
Member of: ICCVOB interface
Gets the master replica for the replica of this VOB
Read-only property
Property Master As String
_bstr_t GetMaster();
Gets the number of supplementary groups for this VOB
Read-only property
Property NumberOfAdditionalGroups As Long
long GetNumberOfAdditionalGroups();
Gets the number of replica names for the VOB family of this VOB, if this VOB is replicated
Read-only property
Property NumberOfReplicas As Long
long GetNumberOfReplicas();
Gets the owner of the VOB
Read-only property
Property Owner As String
_bstr_t GetOwner();
Sets the ownership and group information for this VOB
Method
Sub Protect([ NewOwner As String = "" ], [ NewGroup As String = "" ], [ GroupsToAddStringArray As Variant ], [ GroupsToRemoveStringArray As Variant ])
HRESULT Protect( _bstr_t NewOwner, _str_t NewGroup, const _variant_t& GroupsToAddStringArray = vtMissing, const _variant_t& GroupsToRemoveStringArray = vtMissing);
Member of: ICCVOB interface
Gets the array of replica names for the VOB family of this VOB, if this VOB is replicated
Read-only property
Property ReplicasStringArray As Variant
_variant_t GetReplicasStringArray();
An array of Variants that contains String values which represent the names of VOB replicas.
Sets the master replica for the replica of this VOB
Method
Sub SetMaster(Replica As String, [ Comment As String = "" ])
HRESULT SetMaster( _bstr_t Replica, _bstr_t Comment);
Gets the replica name for this VOB, if the VOB is replicated
Read-only property
Property ThisReplica As String
Gets an existing trigger type
Read-only property
Property TriggerType(Name As String) As CCTriggerType
ICCTriggerTypePtr GetTriggerType(_bstr_t Name);
Member of: ICCVOB interface
Gets all existing trigger types in this VOB
Read-only property
Property TriggerTypes([ IncludeObsoletes As Boolean = False ]) As CCTriggerTypes
ICCTriggerTypesPtr GetTriggerTypes(VARIANT_BOOL IncludeObsoletes);
Member of: ICCVOB interface