ICCHyperlinkType インターフェイス

説明

ICCHyperlinkType インターフェイスは、Rational® ClearCase® ハイパーリンク タイプ オブジェクトを表します。

すべてのハイパーリンクは、ハイパーリンク タイプという種類のインスタンスです。一般に、個々のハイパーリンク タイプに関連付けられる意味はユーザー定義です。 (一部のあらかじめ定義されている種類のハイパーリンク タイプには、Rational ClearCase 自体にとっての意味があり、Rational ClearCase のインプリメンテーションの一部として使用されます。)

継承

ICCHyperlinkType は ICCVOBObject から継承し、ICCVOBObject は IDispatch から継承します。 ICCVOBObject インターフェイス

プロパティと関連メソッド

Group および SetGroup

このハイパーリンク タイプが属しているグループを取得します

このハイパーリンク タイプが属するグループを設定します

HasSharedMastership および ShareMastership

ハイパーリンク タイプが共有されているか、それともマスターにできるかを確認します。

ハイパーリンク タイプを共有するか、それともマスターにできるようにするかを設定します

Master および SetMaster

このハイパーリンク タイプのマスター レプリカを取得します

このハイパーリンク タイプのマスター レプリカを設定します

Name (デフォルト プロパティ) および SetName

このハイパーリンク タイプの名前を取得します

このハイパーリンク タイプの名前を設定します

Owner および SetOwner

このハイパーリンク タイプの所有者を取得します

このハイパーリンク タイプの所有者を設定します

Scope および SetScope

このハイパーリンク タイプの範囲 (例: この VOB に対してローカル) を取得します

このハイパーリンク タイプの範囲 (例: この VOB に対してローカル) を設定します

読み取り専用プロパティ

Lock

このハイパーリンク タイプ上のロックを取得します

VOB

このハイパーリンク タイプが含まれている VOB を取得します

メソッド

Apply

このハイパーリンク タイプのインスタンスを VOB オブジェクトに適用します

CreateLock

このハイパーリンク タイプをロックします

RemoveType

VOB からこのハイパーリンク タイプを削除します

作成

CCHyperlinkType オブジェクトは、以下のインターフェイスから取得できます。

Apply

このハイパーリンク タイプのインスタンスを VOB オブジェクトに適用します

カテゴリ

メソッド

VB 構文

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

Visual C++ 構文

HRESULT Apply(
     ICCVOBObject* pFromObject,
     _bstr_t FromText,
     ICCVOBObject* pToObject,
     _bstr_t ToText,
     VARIANT_BOOL Unidirectional,
     _bstr_t Comment);
パラメータ
説明
pFromObject
ハイパーリンクのリンク元が適用される VOB オブジェクト。
FromText
ハイパーリンクのリンク元を説明するテキスト。FromText を指定しない場合は "" を渡すことができます。
pToObject
ハイパーリンクのリンク先が適用される VOB オブジェクト。リンク先オブジェクトがないことを指定する場合は、Nothing (Visual Basic) または 0(C++) を渡すことができます。
ToText
Visual Basic ではオプション。ハイパーリンクのリンク先を説明するテキスト。
Unidirectional
Visual Basic ではオプション。ハイパーリンクが単一方向である場合は True、ハイパーリンクが双方向である場合は False
Comment
Visual Basic ではオプション。この Apply 操作の履歴レコードに関連付けるコメント。

次のメンバー: ICCHyperlinkType インターフェイス

CreateLock

このハイパーリンク タイプをロックします

カテゴリ

メソッド

VB 構文

Sub CreateLock([ Comment As String = "" ], [ Obsolete As Boolean = False ], [ ExemptUsersStringArray As Variant ])

Visual C++ 構文

HRESULT CreateLock(
     _bstr_t Comment,
     VARIANT_BOOL Obsolete,
     const_variant_t& ExemptUsersStringArray= vtMissing);
パラメータ
説明
Comment
Visual Basic ではオプション。この CreateLock 操作の履歴レコードに関連付けるコメント。
Obsolete
Visual Basic ではオプション。ロックされているハイパーリンク タイプをロックに加えて不要にする場合 (cleartool lock -obsolete と同様) は True、ハイパーリンク タイプを不要にせずにロックする場合は False
ExemptUsersStringArray
オプション。作成しているロックの免除ユーザーの名前を含む文字列値のバリアント配列。

関連項目

Lock

次のメンバー: ICCHyperlinkType インターフェイス

Group

このハイパーリンク タイプが属しているグループを取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property Group As String

Visual C++ 構文

_bstr_t GetGroup();

関連項目

SetGroup

次のメンバー: ICCHyperlinkType インターフェイス

HasSharedMastership

ハイパーリンク タイプが共有されているか、それともマスターにできるかを確認します。

カテゴリ

読み取り専用プロパティ

VB 構文

Property HasSharedMastership As Boolean

Visual C++ 構文

VARIANT_BOOL GetHasSharedMastership();

Lock

このハイパーリンク タイプ上のロックを取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property Lock As CCLock

Visual C++ 構文

ICCLockPtr GetLock();

関連項目

CreateLock

次のメンバー: ICCHyperlinkType インターフェイス

Master

このハイパーリンク タイプのマスター レプリカを取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property Master As String

Visual C++ 構文

_bstr_t GetMaster();

備考

たいていの場合、ユーザーはハイパーリンク タイプのローカル コピー上で操作を行います。

関連項目

SetMaster

次のメンバー: ICCHyperlinkType インターフェイス

Name

このハイパーリンク タイプの名前を取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property Name As String

Visual C++ 構文

_bstr_t GetName();

関連項目

SetName

次のメンバー: ICCHyperlinkType インターフェイス

Owner

このハイパーリンク タイプの所有者を取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property Owner As String

Visual C++ 構文

_bstr_t GetOwner();

関連項目

SetOwner

次のメンバー: ICCHyperlinkType インターフェイス

RemoveType

VOB からこのハイパーリンク タイプを削除します

カテゴリ

メソッド

VB 構文

Sub RemoveType([ RemoveAllInstances As Boolean = False ], [ Comment As String = "" ])

Visual C++ 構文

HRESULT RemoveType(
     VARIANT_BOOL RemoveAllInstances,
     _bstr_t Comment);
パラメータ
説明
RemoveAllInstances
Visual Basic ではオプション。ハイパーリンク タイプとそのタイプのすべてのインスタンスを削除する場合は True、そのタイプにインスタンスが存在しない場合にのみハイパーリンク タイプを削除する場合は False
Comment
Visual Basic ではオプション。この RemoveType 操作の履歴レコードに関連付けるコメント。

次のメンバー: ICCHyperlinkType インターフェイス

Scope

このハイパーリンク タイプの範囲 (例: この VOB に対してローカル) を取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property Scope As CCTypeScope

Visual C++ 構文

CCTypeScope GetScope();

戻り値

CCTypeScope の値。

関連項目

SetScope

次のメンバー: ICCHyperlinkType インターフェイス

SetGroup

このハイパーリンク タイプが属するグループを設定します

カテゴリ

メソッド

VB 構文

Sub SetGroup(NewGroup As String, [ Comment As String = "" ])

Visual C++ 構文

HRESULT SetGroup(
     _bstr_t NewGroup(
     _bstr_t Comment);
パラメータ
説明
NewGroup
ハイパーリンク タイプが属することになる新しいグループの名前。
Comment
Visual Basic ではオプション。この SetGroup 操作の履歴レコードに関連付けるコメント。

関連項目

Group

次のメンバー: ICCHyperlinkType インターフェイス

SetMaster

このハイパーリンク タイプのマスター レプリカを設定します

カテゴリ

メソッド

VB 構文

Sub SetMaster(Replica As String, [ Comment As String = "" ])

Visual C++ 構文

HRESULT SetMaster(
     _bstr_t Replica,
     _bstr_t Comment);
パラメータ
説明
Replica
ハイパーリンク タイプのマスターシップの転送先にするレプリカの名前。Replica が NULL または空である場合は、デフォルトのハイパーリンク タイプ マスターを意味します。
Comment
Visual Basic ではオプション。この SetMaster 操作の履歴レコードに関連付けるコメント。

備考

たいていの場合、ユーザーはハイパーリンク タイプのローカル コピー上で操作を行います。

関連項目

Master

次のメンバー: ICCHyperlinkType インターフェイス

SetName

このハイパーリンク タイプの名前を設定します

カテゴリ

メソッド

VB 構文

Sub SetName(NewName As String, [ Comment As String = "" ])

Visual C++ 構文

HRESULT SetName(
     _bstr_t NewName,
     _bstr_t Comment);
パラメータ
説明
NewName
このハイパーリンク タイプの新しい名前。
Comment
Visual Basic ではオプション。この SetName 操作の履歴レコードに関連付けるコメント。

関連項目

Name

次のメンバー: ICCHyperlinkType インターフェイス

SetOwner

このハイパーリンク タイプの所有者を設定します

カテゴリ

メソッド

VB 構文

Sub SetOwner(NewOwner As String, [ Comment As String = "" ])

Visual C++ 構文

HRESULT SetOwner(
     _bstr_t NewOwner,
     _bstr_t Comment);
パラメータ
説明
NewOwner
ハイパーリンク タイプの所有権の転送先にする所有者の名前。
Comment
Visual Basic ではオプション。この SetOwner 操作の履歴レコードに関連付けるコメント。

関連項目

Owner

次のメンバー: ICCHyperlinkType インターフェイス

SetScope

このハイパーリンク タイプの範囲 (例: この VOB に対してローカル) を設定します

カテゴリ

メソッド

VB 構文

Sub SetScope(Global As Boolean, [ Acquire As Boolean = False ], [ Comment As String = "" ])

Visual C++ 構文

HRESULT SetScope(
     VARIANT_BOOL Global,
     VARIANT_BOOL Acquire,
     _bstr_t Comment);
パラメータ
説明
Global
このハイパーリンク タイプをグローバルにする場合に True。グローバル タイプは、そのタイプが含まれている VOB を管理 VOB として使用するすべての VOB で利用できます。False にした場合、このハイパーリンク タイプは、このタイプが含まれている VOB 内でのみ使用される通常のタイプになります。
Acquire
Visual Basic ではオプション。既存の通常のタイプがこの操作によって見えなくなるときにそのタイプをこのグローバル ハイパーリンク タイプのローカル コピーに変換する場合は True (Global が True の場合のみ可能)、既存のタイプが見えなくなるときに操作を失敗させる場合は False。(見えなくなるタイプは、管理 VOB 内のグローバル タイプと同じ名前を持つタイプです。)
Comment
Visual Basic ではオプション。この SetScope 操作の履歴レコードに関連付けるコメント。

関連項目

Scope

次のメンバー: ICCHyperlinkType インターフェイス

ShareMastership

ハイパーリンク タイプを共有するか、それともマスターにできるようにするかを設定します

カテゴリ

メソッド

VB 構文

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

Visual C++ 構文

HRESULT ShareMastership(_bstr_t Comment);
パラメータ
説明
Comment
Visual Basic ではオプション。この ShareMastership 操作の履歴レコードに関連付けるコメント。

VOB

このハイパーリンク タイプが含まれている VOB を取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property VOB As CCVOB

Visual C++ 構文

ICCVOBPtr GetVOB();

次のメンバー: ICCHyperlinkType インターフェイス