ICCHyperlinkType interface

Description

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.)

Inheritance

ICCHyperlinkType
inherits from ICCVOBObject, which inherits from IDispatch. ICCVOBObject interface

Properties and related methods

Group and SetGroup

Gets the group to which this hyperlink type belongs

Sets the group to which this hyperlink type belongs

HasSharedMastership and ShareMastership

Gets whether hyperlink type is shared or can be mastered

Sets whether hyperlink type is shared or can be mastered

Master and SetMaster

Gets the master replica for this hyperlink type

Sets the master replica for this hyperlink type

Name (default property) and SetName

Gets the name of this hyperlink type

Sets the name of this hyperlink type

Owner and SetOwner

Gets the owner of this hyperlink type

Sets the owner of this hyperlink type

Scope and SetScope

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)

Read-only properties

Lock

Gets the lock on this hyperlink type

VOB

Gets the VOB that contains this hyperlink type

Methods

Apply

Applies an instance of this hyperlink type to a VOB object

CreateLock

Locks this hyperlink type

RemoveType

Removes this hyperlink type from the VOB

Examples

Creation

You can get a CCHyperlinkType object from the following interfaces:

Apply

Applies an instance of this hyperlink type to a VOB object

Category

Method

VB syntax

Sub Apply(pFromObject As CCVOBObject, FromText As String, pToObject As CCVOBObject, [ ToText As String = "" ], [ Unidirectional As Boolean = False ], [ Comment As String = "" ])

Visual C++ syntax

HRESULT Apply(
     ICCVOBObject* pFromObject,
     _bstr_t FromText,
     ICCVOBObject* pToObject,
     _bstr_t ToText,
     VARIANT_BOOL Unidirectional,
     _bstr_t Comment);
Parameter
Description
pFromObject
The VOB object to which the from end of the hyperlink is applied.
FromText
The text describing the from end of the hyperlink. You can pass "" to specify the absence of FromText.
pToObject
The VOB object to which the to end of the hyperlink is applied. You can pass Nothing (Visual Basic) or 0 (C++) to specify there is no to object.
ToText
Optional in Visual Basic. The text describing the to end of the hyperlink.
Unidirectional
Optional in Visual Basic. True is the hyperlink is unidirectional; False if the hyperlink is bidirectional.
Comment
Optional in Visual Basic. A comment to associate with the history record for this Apply operation.

Member of: ICCHyperlinkType interface

CreateLock

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

See also

Lock

Member of: ICCHyperlinkType interface

Group

Gets the group to which this hyperlink type belongs

Category

Read-only property

VB syntax

Property Group As String

Visual C++ syntax

_bstr_t GetGroup();

HasSharedMastership

Gets whether hyperlink type is shared or can be mastered

Category

Read-only property

VB syntax

Property HasSharedMastership As Boolean

Visual C++ syntax

VARIANT_BOOL GetHasSharedMastership();

Lock

Gets the lock on this hyperlink type

Category

Read-only property

VB syntax

Property Lock As CCLock

Visual C++ syntax

ICCLockPtr GetLock();

Master

Gets the master replica for this hyperlink 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 hyperlink type.

Name

Gets the name of this hyperlink type

Category

Read-only property

VB syntax

Property Name As String

Visual C++ syntax

_bstr_t GetName();

Owner

Gets the owner of this hyperlink type

Category

Read-only property

VB syntax

Property Owner As String

Visual C++ syntax

_bstr_t GetOwner();

RemoveType

Removes this hyperlink type from the 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 hyperlink type and all instances of the type; False to remove the hyperlink 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: ICCHyperlinkType interface

Scope

Gets the scope for this hyperlink 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.

SetGroup

Sets the group to which this hyperlink 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
The name of the new group to which the hyperlink type will belong.
Comment
Optional in Visual Basic. A comment to associate with the history record for this SetGroup operation.

See also

Group

Member of: ICCHyperlinkType interface

SetMaster

Sets the master replica for this hyperlink 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 hyperlink type is being transferred. A null or empty Replica denotes the default hyperlink type master.
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 hyperlink type.

SetName

Sets the name of this hyperlink 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 hyperlink type.
Comment
Optional in Visual Basic. A comment to associate with the history record for this SetName operation.

See also

Name

Member of: ICCHyperlinkType interface

SetOwner

Sets the owner of this hyperlink 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 hyperlink type is being transferred.
Comment
Optional in Visual Basic. A comment to associate with the history record for this SetOwner operation.

See also

Owner

Member of: ICCHyperlinkType interface

SetScope

Sets the scope for this hyperlink 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 hyperlink type global. Global types are accessible to all VOBs that use as an administrative VOB the VOB containing the type. False to make this hyperlink 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 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.)
Comment
Optional in Visual Basic. A comment to associate with the history record for this SetScope operation.

See also

Scope

Member of: ICCHyperlinkType interface

ShareMastership

Sets whether hyperlink type is shared or can be mastered

Category

Method

VB syntax

Sub ShareMastership([ Comment As String = "" ])

Visual C++ syntax

HRESULT ShareMastership(_bstr_t Comment);
Parameter
Description
Comment
Optional in Visual Basic. A comment to associate with the history record for this ShareMastership operation.

VOB

Gets the VOB that contains this hyperlink type

Category

Read-only property

VB syntax

Property VOB As CCVOB

Visual C++ syntax

ICCVOBPtr GetVOB();

Member of: ICCHyperlinkType interface


Feedback