The ICCHyperlinkType interface represents the Rational® ClearCase® hyperlink type object.
Every hyperlink is an instance of a kind of hyperlink type. In general, the meaning associated with a particular hyperlink type is user-defined. (Some predefined kinds of hyperlink types have meaning to Rational ClearCase itself and are used as part of the implementation of Rational ClearCase.)
Gets the scope for this hyperlink type (for example, local to this VOB)
Sets the scope for this hyperlink type (for example, local to this VOB)
Applies an instance of this hyperlink type to a VOB object
Method
Sub Apply(pFromObject As CCVOBObject, FromText As String, pToObject As CCVOBObject, [ ToText As String = "" ], [ Unidirectional As Boolean = False ], [ Comment As String = "" ])
HRESULT Apply( ICCVOBObject* pFromObject, _bstr_t FromText, ICCVOBObject* pToObject, _bstr_t ToText, VARIANT_BOOL Unidirectional, _bstr_t Comment);
Member of: ICCHyperlinkType interface
Locks this hyperlink type
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 the group to which this hyperlink type belongs
Read-only property
Property Group As String
_bstr_t GetGroup();
Gets the lock on this hyperlink type
Read-only property
Property Lock As CCLock
ICCLockPtr GetLock();
Gets the master replica for this hyperlink type
Read-only property
Property Master As String
_bstr_t GetMaster();
It is most likely that you want to operate on the local copy of the hyperlink type.
Gets the name of this hyperlink type
Read-only property
Property Name As String
_bstr_t GetName();
Gets the owner of this hyperlink type
Read-only property
Property Owner As String
_bstr_t GetOwner();
Removes this hyperlink type from the VOB
Method
Sub RemoveType([ RemoveAllInstances As Boolean = False ], [ Comment As String = "" ])
HRESULT RemoveType( VARIANT_BOOL RemoveAllInstances, _bstr_t Comment);
Member of: ICCHyperlinkType interface
Gets the scope for this hyperlink type (for example, local to this VOB)
Read-only property
Property Scope As CCTypeScope
CCTypeScope GetScope();
A CCTypeScope value.
Sets the group to which this hyperlink type belongs
Method
Sub SetGroup(NewGroup As String, [ Comment As String = "" ])
HRESULT SetGroup( _bstr_t NewGroup( _bstr_t Comment);
Sets the master replica for this hyperlink type
Method
Sub SetMaster(Replica As String, [ Comment As String = "" ])
HRESULT SetMaster( _bstr_t Replica, _bstr_t Comment);
It is most likely that you want to operate on the local copy of the hyperlink type.
Sets the name of this hyperlink type
Method
Sub SetName(NewName As String, [ Comment As String = "" ])
HRESULT SetName( _bstr_t NewName, _bstr_t Comment);
Sets the owner of this hyperlink type
Method
Sub SetOwner(NewOwner As String, [ Comment As String = "" ])
HRESULT SetOwner( _bstr_t NewOwner, _bstr_t Comment);
Sets the scope for this hyperlink type (for example, local to this VOB)
Method
Sub SetScope(Global As Boolean, [ Acquire As Boolean = False ], [ Comment As String = "" ])
HRESULT SetScope( VARIANT_BOOL Global, VARIANT_BOOL Acquire, _bstr_t Comment);
Gets the VOB that contains this hyperlink type
Read-only property
Property VOB As CCVOB