ICCTriggerType インターフェイス

説明

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

すべてのトリガは、トリガ タイプという種類のインスタンスです。個々のトリガ タイプに関連付けられる意味はユーザー定義です。

継承

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

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

DebugPrinting および SetDebugPrinting

トリガの起動時にデバッグ出力が行われるかどうかを判別します

トリガの起動時にデバッグ出力を行うかどうかを設定します

ExemptUsersStringArray および SetExemptUsersStringArray

このトリガ タイプを起動する対象から外されているユーザーを取得します

このトリガ タイプを起動する対象から外すユーザーを設定します

Group および SetGroup

このトリガ タイプが属しているグループを取得します

このトリガ タイプが属するグループを設定します

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

このトリガ タイプの名前を取得します

このトリガ タイプの名前を設定します

Owner および SetOwner

このトリガ タイプの所有者を取得します

このトリガ タイプの所有者を設定します

読み取り専用プロパティ

ActionsArray

このトリガ タイプのアクションと値のペア (タイプの後に 1 つか 2 つの値が続いたもの) を取得します

Firing

トリガ タイプの起動順序 (操作前 (pre-op) か操作後 (post-op) のいずれか) を取得します

InclusionsArray

このタイプ トリガ タイプの包含リストを取得します

KindOfTrigger

このトリガ タイプのトリガの種類を取得します

Lock

このトリガ タイプ上のロックを取得します

NumberOfActions

このトリガ タイプのアクションの数を取得します

NumberOfExemptUsers

このトリガ タイプを起動する対象から外されているユーザーの数を取得します

NumberOfInclusions

含まれているこのタイプ トリガ タイプの数を取得します

NumberOfOperationKinds

このトリガ タイプを起動する操作の種類の数を取得します

NumberOfRestrictions

このエレメント トリガ タイプの制限の数を取得します

OperationKindsArray

このトリガ タイプを起動する操作の種類の配列を取得します

RestrictionsArray

このエレメント トリガ タイプの制限リストを取得します

VOB

このトリガ タイプを含む VOB を取得します

メソッド

Apply

このトリガ タイプのインスタンスをエレメントに適用します

ApplyUCM

このトリガ タイプのインスタンスを UCM エレメント (ICCActivity、ICCBaseline、ICCComponent、ICCFolder、ICCProject、および ICCStream) に適用します

CreateBuilderFromType

このトリガ タイプのパラメータを変更するためのトリガ タイプ ビルダーを取得します

CreateLock

このトリガ タイプをロックします

RemoveType

VOB からこのトリガ タイプを削除します

作成

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

ActionsArray

このトリガ タイプのアクションと値のペア (タイプの後に 1 つか 2 つの値が続いたもの) を取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property ActionsArray As Variant

Visual C++ 構文

_variant_t GetActionsArray();

戻り値

アクションと同じ数の行を持つ、希薄な配列。各行には、アクションのタイプに応じて、CCTriggerActionType 値の後に 1 か 2 つの値が並んだバリアントが含まれています。

Apply

このトリガ タイプのインスタンスをエレメントに適用します

カテゴリ

メソッド

VB 構文

Sub Apply(pElement As CCElement, [ Comment As String = "" ], [ Force As Boolean = False ], [ Recurse As Boolean = False ], [ DirectoryListsSubset As Variant ])

Visual C++ 構文

HRESULT Apply(
     ICCElement* pElement,
     _bstr_t Comment,
     VARIANT_BOOL Force,
     VARIANT_BOOL Recurse,
     const _variant_t& DirectoryListsSubset = vtMissing);
パラメータ
説明
pElement
トリガを適用するエレメント。
Comment
Visual Basic ではオプション。この Apply 操作の履歴レコードに関連付けるコメント。
Force
Visual Basic ではオプション。エレメントがトリガ タイプ定義と一致していなくてもエレメントにトリガを関連付ける場合は True、エレメント タイプがトリガ定義と一致しないときに操作を失敗させる場合は False
Recurse
Visual Basic ではオプション。すべてのディレクトリ エレメントでサブツリー全体を処理する場合は True、ディレクトリ エレメントそのもの、または 1 つのファイルだけを処理する場合は False
DirectoryListsSubset
オプション。トリガがディレクトリに関連付けられている場合、DirectoryListsSubset はトリガを関連付けリストや継承リストに含めるかどうかを制御します。この値は、いずれかの有効な CCTriggerDirectorySubset 値を含むバリアントである必要があります。

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

ApplyUCM

このトリガ タイプのインスタンスを UCM エレメント (ICCActivity、ICCBaseline、ICCComponent、ICCFolder、ICCProject、および ICCStream) に適用します

カテゴリ

メソッド

VB 構文

Sub Apply(pElement As CCElement, [ Comment As String = "" ], [ Force As Boolean = False ], [ Recurse As Boolean = False ], [ DirectoryListsSubset As Variant ])

Visual C++ 構文

HRESULT Apply(
     ICCElement* pElement,
     _bstr_t Comment,
     VARIANT_BOOL Force,
     VARIANT_BOOL Recurse,
     const _variant_t& DirectoryListsSubset = vtMissing);
パラメータ
説明
pElement
トリガを適用するエレメント。
Comment
Visual Basic ではオプション。この Apply 操作の履歴レコードに関連付けるコメント。
Force
Visual Basic ではオプション。エレメントがトリガ タイプ定義と一致していなくてもエレメントにトリガを関連付ける場合は True、エレメント タイプがトリガ定義と一致しないときに操作を失敗させる場合は False
Recurse
Visual Basic ではオプション。すべてのディレクトリ エレメントでサブツリー全体を処理する場合は True、ディレクトリ エレメントそのもの、または 1 つのファイルだけを処理する場合は False
DirectoryListsSubset
オプション。トリガがディレクトリに関連付けられている場合、DirectoryListsSubset はトリガを関連付けリストや継承リストに含めるかどうかを制御します。この値は、いずれかの有効な CCTriggerDirectorySubset 値を含むバリアントである必要があります。

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

CreateBuilderFromType

このトリガ タイプのパラメータを変更するためのトリガ タイプ ビルダーを取得します

カテゴリ

メソッド

VB 構文

Function CreateBuilderFromType As CCTriggerTypeBuilder

Visual C++ 構文

ICCTriggerTypeBuilderPtr CreateBuilderFromType();

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

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

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

DebugPrinting

トリガの起動時にデバッグ出力が行われるかどうかを判別します

カテゴリ

読み取り専用プロパティ

VB 構文

Property DebugPrinting As Boolean

Visual C++ 構文

VARIANT_BOOL GetDebugPrinting();

ExemptUsersStringArray

このトリガ タイプを起動する対象から外されているユーザーを取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property ExemptUsersStringArray As Variant

Visual C++ 構文

_variant_t GetExemptUsersStringArray();

戻り値

このトリガ タイプのトリガの起動を免除するユーザーの名前を表す文字列値を含むバリアントの配列。

Firing

トリガ タイプの起動順序 (操作前 (pre-op) か操作後 (post-op) のいずれか) を取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property Firing As CCTriggerFiring

Visual C++ 構文

CCTriggerFiring GetFiring();

戻り値

CCTriggerFiring の値。

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

Group

このトリガ タイプが属しているグループを取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property Group As String

Visual C++ 構文

_bstr_t GetGroup();

関連項目

SetGroup

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

InclusionsArray

このタイプ トリガ タイプの包含リストを取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property InclusionsArray As Variant

Visual C++ 構文

_variant_t GetInclusionsArray();

戻り値

包含オブジェクト リストを表すバリアントの配列。これには、CCTriggerTypeAll 値、オブジェクト ポインタ、または文字列値があります。CCTriggerTypesAll 値は特定の種類のすべてのメタデータ タイプ (例えば、すべての属性タイプ) の場合、オブジェクト ポインタは特定のメタデータ タイプ (例えば、特定の CCAttributeType) の場合、文字列値は特定のエレメント タイプの名前 (例えば、text_file) の場合に返されます。

KindOfTrigger

このトリガ タイプのトリガの種類を取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property KindOfTrigger As CCKindOfTrigger

Visual C++ 構文

CCKindOfTrigger GetKindOfTrigger();

戻り値

CCKindOfTrigger の値。

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

Lock

このトリガ タイプ上のロックを取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property Lock As CCLock

Visual C++ 構文

ICCLockPtr GetLock();

関連項目

CreateLock

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

Name

このトリガ タイプの名前を取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property Name As String

Visual C++ 構文

_bstr_t GetName();

関連項目

SetName

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

NumberOfActions

このトリガ タイプのアクションの数を取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property NumberOfActions As Long

Visual C++ 構文

long GetNumberOfActions();

関連項目

ActionsArray

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

NumberOfExemptUsers

このトリガ タイプを起動する対象から外されているユーザーの数を取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property NumberOfExemptUsers As Long

Visual C++ 構文

long GetNumberOfExemptUsers();

NumberOfInclusions

含まれているこのタイプ トリガ タイプの数を取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property NumberOfInclusions As Long

Visual C++ 構文

long GetNumberOfInclusions();

NumberOfOperationKinds

このエレメント トリガ タイプの制限の数を取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property NumberOfOperationKinds As Long

Visual C++ 構文

long GetNumberOfOperationKinds();

NumberOfRestrictions

このエレメント トリガ タイプの制限の数を取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property NumberOfRestrictions As Long

Visual C++ 構文

long GetNumberOfRestrictions();

OperationKindsArray

このトリガ タイプを起動する操作の種類の配列を取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property OperationKindsArray As Variant

Visual C++ 構文

_variant_t GetOperationKindsArray();

戻り値

CCTriggerOperationKind 値を含むバリアントの配列。

Owner

このトリガ タイプの所有者を取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property Owner As String

Visual C++ 構文

_bstr_t GetOwner();

関連項目

SetOwner

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

RemoveType

VOB からこのトリガ タイプを削除します

カテゴリ

メソッド

VB 構文

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

Visual C++ 構文

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

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

RestrictionsArray

このエレメント トリガ タイプの制限リストを取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property RestrictionsArray As Variant

Visual C++ 構文

_variant_t GetRestrictionsArray();

戻り値

制限リストを表すバリアントの配列。これにはオブジェクト ポインタや文字列値があります。オブジェクト ポインタは特定のメタデータ タイプ (例えば、特定の CCAttributeType) の場合に、文字列値は特定のエレメント タイプの名前 (例えば、text_file) の場合に返されます。

SetDebugPrinting

トリガの起動時にデバッグ出力を行うかどうかを設定します

カテゴリ

メソッド

VB 構文

Sub SetDebugPrinting([ NewDebugPrinting As Boolean ], [ Comment As String = "" ])

Visual C++ 構文

HRESULT SetDebugPrinting(
     VARIANT_BOOL NewDebugPrinting,
     _bstr_t Comment);
パラメータ
説明
NewDebugPrinting
Visual Basic ではオプション。トリガ起動時に常にデバッグ出力を有効にする場合は True、トリガ起動を出力なしで起動させる場合は False
Comment
Visual Basic ではオプション。この SetDebugPrinting 操作の履歴レコードに関連付けるコメント。

備考

SetDebugPrinting は、デバッグを目的とする場合にのみ使用します。デバッグ出力は stdout に入れられます。出力を参照するには、コマンド行からトリガをテストする必要があります。デバッグが完了したなら、トリガの起動時に混乱が生じないよう、デバッグ出力を無効にしておいてください。

SetExemptUsersStringArray

このトリガ タイプを起動する対象から外すユーザーを設定します

カテゴリ

メソッド

VB 構文

Sub SetExemptUsersStringArray([ ExemptUsersStringArray As Variant ], [ Comment As String = "" ])

Visual C++ 構文

HRESULT SetExemptUsersStringArray(
     const _variant_t& ExemptUsersStringArray,
     _bstr_t Comment);
パラメータ
説明
ExemptUsersStringArray
Visual Basic ではオプション。このトリガ タイプのトリガの起動を免除するユーザーの名前を含む文字列値のバリアント配列。
Comment
Visual Basic ではオプション。この SetExemptUsersStringArray 操作の履歴レコードに関連付けるコメント。

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

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

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

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

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

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

VOB

このトリガ タイプを含む VOB を取得します

カテゴリ

読み取り専用プロパティ

VB 構文

Property VOB As CCVOB

Visual C++ 構文

ICCVOBPtr GetVOB();

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