ICCHyperlink interface
Description
The ICCHyperlink interface represents the DevOps Code ClearCase® hyperlink object.
In DevOps Code ClearCase, you can attach unidirectional or bidirectional hyperlinks to one or two ICCVOBObject objects. Each end of such a hyperlink can have associated text.
Inheritance

Properties and related methods
- Group and SetGroup
Gets the group to which this hyperlink belongs
Sets the group to which this hyperlink belongs
- Master and SetMaster
Gets the master replica for this hyperlink
Sets the master replica for this hyperlink
- Owner and SetOwner
Gets the owner of this hyperlink
Sets the owner of this hyperlink
Read-only properties
- FromObject
Gets the from-object of the hyperlink
- FromText
Gets the from-text on the from-object of the hyperlink
- IDString (default property)
Gets the string that identifies the hyperlink (type-name@id@vob-selector)
- ToObject
Gets the to-object of the hyperlink
- ToText
Gets the to-text on the to-object of the hyperlink
- Type
Gets the hyperlink type of this hyperlink
- Unidirectional
Gets whether or not the hyperlink object can be navigated only in one direction (from-object -> to-object)
- VOB
Gets the VOB that contains this hyperlink
Methods
- Remove
Remove the hyperlink from the objects to which it is attached
Creation
FromObject
Gets the from-object of the hyperlink
Category
Read-only property
VB syntax
Property FromObject As CCVOBObject
FromText
Gets the from-text on the from-object of the hyperlink
Category
Read-only property
VB syntax
Property FromText As String
Group
Gets the group to which this hyperlink belongs
Category
Read-only property
VB syntax
Property Group As String
Visual C++ syntax
_bstr_t GetGroup();
IDString
Gets the string that identifies the hyperlink (type-name@id@vob-selector)
Category
Read-only property
VB syntax
Property IDString As String
Master
Gets the master replica for this hyperlink
Category
Read-only property
VB syntax
Property Master As String
Visual C++ syntax
_bstr_t GetMaster();
Owner
Gets the owner of this hyperlink
Category
Read-only property
VB syntax
Property Owner As String
Visual C++ syntax
_bstr_t GetOwner();
Remove
Remove the hyperlink from the objects to which it is attached
Category
Method
VB syntax
Sub Remove([ Comment As String = "" ])
Visual C++ syntax
HRESULT Remove(_bstr_t Comment);
- Parameter
- Description
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this Remove operation.
Member of: ICCHyperlink interface
SetGroup
Sets the group to which this hyperlink 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 hyperlink 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 hyperlink
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 hyperlink is being transferred.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetMaster operation.
SetOwner
Sets the owner of this hyperlink
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 hyperlink is being transferred.
- Comment
- Optional in Visual Basic. A comment to associate with the history record for this SetOwner operation.
ToObject
Gets the to-object of the hyperlink
Category
Read-only property
VB syntax
Property ToObject As CCVOBObject
ToText
Gets the to-text on the to-object of the hyperlink
Category
Read-only property
VB syntax
Property ToText As String
Type
Gets the hyperlink type of this hyperlink
Category
Read-only property
VB syntax
Property Type As CCHyperlinkType
Visual C++ syntax
ICCHyperlinkTypePtr GetType();
Return value
The local copy of the global type, not a handle to the global type.
Member of: ICCHyperlink interface
Unidirectional
Gets whether or not the hyperlink object can be navigated only in one direction (from-object -> to-object)
Category
Read-only property
VB syntax
Property Unidirectional As Boolean