ホーム › System.Performance › IAlertDataCollector

IAlertDataCollector

COMIDispatch (デュアル)

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID03837516-098b-11d8-9414-505054503030継承元IDataCollector呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl32

公式ドキュメント

パフォーマンスカウンターを監視し、カウンター値が指定されたしきい値を超えるたびにアクションを実行します。アラートデータコレクターを作成するには、IDataCollectorCollection::CreateDataCollector メソッドまたは IDataCollectorCollection::CreateDataCollectorFromXml メソッドを呼び出します。CreateDataCollectorFromXml に渡す XML の詳細については、「解説」を参照してください。

解説(Remarks)

このオブジェクトを作成するために CreateDataCollectorFromXml を呼び出す場合、次の例に示す XML を使用してオブジェクトを初期化できます。IDataCollector::Xml プロパティもこの XML を返します。

<AlertDataCollector>
    <Alert/>              <!-- アラートごとに <Alert> 要素を指定します -->
    <AlertDisplayName/>   <!-- 読み取り専用。以下の内容が含まれます -->
                          <!-- ユーザーのロケールでの <Alert/> -->
    <EventLog/>           <!-- 0 以外 (true)、0 (false) -->
    <SampleInterval/>
    <Task/>
    <TaskArguments/>
    <TaskRunAsSelf/>
    <TaskUserTextArguments/>
    <TriggerDataCollectorSet/>
</AlertDataCollector>

この例には、併せて指定する必要がある IDataCollector から継承されたプロパティ要素は示されていない点に注意してください。

コレクターを作成するための XML を指定する際は、設定したいプロパティの要素のみを指定できます。プロパティを指定しない場合、PLA は既定値を提供します。コレクターの XML を取得すると、その XML には IDataCollector のものを含むすべての要素が含まれます。

メソッド 16

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 32 HRESULT get_AlertThresholds(SAFEARRAY** alerts)

監視するパフォーマンスカウンターとしきい値の一覧を取得または設定します。(Get)

alerts

SAFEARRAY**

out

現在のアラートのしきい値の一覧を受け取るポインタである。

解説(Remarks)

少なくとも 1 つのアラートしきい値を指定する必要があります。カウンター値が指定したしきい値を超えると、PLA は次のアクションのうち 1 つ以上を実行します。

IAlertDataCollector::EventLog プロパティが true の場合、Microsoft-Windows-Diagnosis-PLA/Operational イベントログにイベント 2031 を記録します。
指定されている場合、IAlertDataCollector::Task プロパティのタスクを開始します。
指定されている場合、IAlertDataCollector::TriggerDataCollectorSet プロパティで指定されたデータコレクターセットを実行するようトリガーします。

XML を使用してアラートを定義する場合、大なり記号 (>) には ">" を、小なり記号 (<) には "<" を使用する必要があります。

vtbl 33 HRESULT put_AlertThresholds(SAFEARRAY* alerts)

監視するパフォーマンスカウンターとしきい値の一覧を取得または設定します。(Put)

alerts

SAFEARRAY*

アラートのしきい値の一覧を設定する。

解説(Remarks)

IAlertDataCollector::EventLog プロパティが true の場合、Microsoft-Windows-Diagnosis-PLA/Operational イベントログにイベント 2031 を記録します。
指定されている場合、IAlertDataCollector::Task プロパティのタスクを開始します。
指定されている場合、IAlertDataCollector::TriggerDataCollectorSet プロパティで指定されたデータコレクターセットを実行するようトリガーします。

XML を使用してアラートを定義する場合、大なり記号 (>) には ">" を、小なり記号 (<) には "<" を使用する必要があります。

vtbl 34 HRESULT get_EventLog(VARIANT_BOOL* log)

カウンター値がしきい値を超えるたびに PLA がイベントを記録するかどうかを示す値を取得または設定します。(Get)

log

VARIANT_BOOL*

out

現在のイベントログへ記録するかどうかを受け取るポインタである。

vtbl 35 HRESULT put_EventLog(VARIANT_BOOL log)

カウンター値がしきい値を超えるたびに PLA がイベントを記録するかどうかを示す値を取得または設定します。(Put)

log

VARIANT_BOOL

イベントログへ記録するかどうかを設定する。

vtbl 36 HRESULT get_SampleInterval(DWORD* interval)

カウンターデータのサンプリング間で待機する時間間隔を取得または設定します。(Get)

interval

DWORD*

out

現在のサンプリング間隔(秒)を受け取るポインタである。

vtbl 37 HRESULT put_SampleInterval(DWORD interval)

カウンターデータのサンプリング間で待機する時間間隔を取得または設定します。(Put)

interval

DWORD

サンプリング間隔(秒)を設定する。

vtbl 38 HRESULT get_Task(LPWSTR* task)

カウンター値がしきい値を超えるたびに開始するタスクスケジューラのジョブ名を取得または設定します。(Get)

task

LPWSTR*

out

現在の完了時に実行するタスクを受け取るポインタである。

解説(Remarks)

タスクにコマンドライン引数を指定するには、IAlertDataCollector::TaskArguments プロパティおよび IAlertDataCollector::TaskUserTextArguments プロパティを参照してください。

PLA がデータを収集しているディレクトリでタスクを開始するには、タスクの Start in フィールドに $(Arg1) を設定します。

vtbl 39 HRESULT put_Task(LPWSTR task)

カウンター値がしきい値を超えるたびに開始するタスクスケジューラのジョブ名を取得または設定します。(Put)

task

LPWSTR

完了時に実行するタスクを設定する。

解説(Remarks)

PLA がデータを収集しているディレクトリでタスクを開始するには、タスクの Start in フィールドに $(Arg1) を設定します。

vtbl 40 HRESULT get_TaskRunAsSelf(VARIANT_BOOL* RunAsSelf)

タスクをデータコレクターセットのユーザーとして実行するか、タスクで指定されたユーザーとして実行するかを決定する値を取得または設定します。(IAlertDataCollector.get_TaskRunAsSelf)

RunAsSelf

VARIANT_BOOL*

out

現在のタスクを自身の資格情報で実行するかどうかを受け取るポインタである。

vtbl 41 HRESULT put_TaskRunAsSelf(VARIANT_BOOL RunAsSelf)

タスクをデータコレクターセットのユーザーとして実行するか、タスクで指定されたユーザーとして実行するかを決定する値を取得または設定します。(IAlertDataCollector.put_TaskRunAsSelf)

RunAsSelf

VARIANT_BOOL

タスクを自身の資格情報で実行するかどうかを設定する。

vtbl 42 HRESULT get_TaskArguments(LPWSTR* task)

IAlertDataCollector::Task プロパティで指定されたタスクスケジューラのジョブに渡すコマンドライン引数を取得または設定します。(IAlertDataCollector.get_TaskArguments)

task

LPWSTR*

out

現在のタスクに渡す引数を受け取るポインタである。

解説(Remarks)

実行するタスクがスクリプトの場合、タスクスケジューラでタスク引数を $(Arg0) に設定する必要があります。設定しないと、このプロパティで指定した引数はスクリプトに渡されません。

PLA には、引数文字列に含めることができる次の置換変数が用意されています。PLA は、アラートがトリガーされたときに置換変数の値を提供します。中かっこはエスケープする必要があります (例: {name})。

変数	説明
{counter}	しきい値を超えたパフォーマンスカウンターのパス。
{date}	しきい値を超えた時刻。
{name}	アラートデータコレクターの名前。
{threshold}	しきい値の値。
{usertext}	IAlertDataCollector::TaskUserTextArguments プロパティの文字列。
{value}	パフォーマンスカウンターの値。

通常、置換変数を使用する場合は、中かっこをエスケープする必要のない TaskUserTextArguments でそれらを指定し、このプロパティには {usertext} を指定します。

vtbl 43 HRESULT put_TaskArguments(LPWSTR task)

IAlertDataCollector::Task プロパティで指定されたタスクスケジューラのジョブに渡すコマンドライン引数を取得または設定します。(IAlertDataCollector.put_TaskArguments)

task

LPWSTR

タスクに渡す引数を設定する。

解説(Remarks)

変数	説明
{counter}	しきい値を超えたパフォーマンスカウンターのパス。
{date}	しきい値を超えた時刻。
{name}	アラートデータコレクターの名前。
{threshold}	しきい値の値。
{usertext}	IAlertDataCollector::TaskUserTextArguments プロパティの文字列。
{value}	パフォーマンスカウンターの値。

vtbl 44 HRESULT get_TaskUserTextArguments(LPWSTR* task)

IAlertDataCollector::Task プロパティで指定されたタスクスケジューラのジョブに渡すコマンドライン引数を取得または設定します。(IAlertDataCollector.get_TaskUserTextArguments)

task

LPWSTR*

out

現在のタスクに渡すユーザー定義テキスト引数を受け取るポインタである。

解説(Remarks)

これらの引数は、IAlertDataCollector::TaskArguments プロパティに {usertext} 置換変数が含まれている場合にのみ、タスクスケジューラのジョブに渡されるコマンドライン引数に含まれます。

PLA には、引数文字列に含めることができる次の置換変数が用意されています。PLA は、アラートがトリガーされたときに置換変数の値を提供します。中かっこはエスケープしません。

変数	説明
{counter}	しきい値を超えたパフォーマンスカウンターのパス。
{date}	しきい値を超えた時刻。
{name}	アラートデータコレクターの名前。
{threshold}	しきい値の値。
{value}	パフォーマンスカウンターの値。

vtbl 45 HRESULT put_TaskUserTextArguments(LPWSTR task)

IAlertDataCollector::Task プロパティで指定されたタスクスケジューラのジョブに渡すコマンドライン引数を取得または設定します。(IAlertDataCollector.put_TaskUserTextArguments)

task

LPWSTR

タスクに渡すユーザー定義テキスト引数を設定する。

解説(Remarks)

変数	説明
{counter}	しきい値を超えたパフォーマンスカウンターのパス。
{date}	しきい値を超えた時刻。
{name}	アラートデータコレクターの名前。
{threshold}	しきい値の値。
{value}	パフォーマンスカウンターの値。

vtbl 46 HRESULT get_TriggerDataCollectorSet(LPWSTR* name)

カウンター値がしきい値を超えるたびに開始するデータコレクターセットの名前を取得または設定します。(Get)

name

LPWSTR*

out

現在のアラート時に起動するデータコレクターセット名を受け取るポインタである。

vtbl 47 HRESULT put_TriggerDataCollectorSet(LPWSTR name)

カウンター値がしきい値を超えるたびに開始するデータコレクターセットの名前を取得または設定します。(Put)

name

LPWSTR

アラート時に起動するデータコレクターセット名を設定する。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IAlertDataCollector "{03837516-098B-11D8-9414-505054503030}"
#usecom global IAlertDataCollector IID_IAlertDataCollector "{}"
#comfunc global IAlertDataCollector_get_AlertThresholds          32 var
#comfunc global IAlertDataCollector_put_AlertThresholds          33 var
#comfunc global IAlertDataCollector_get_EventLog                 34 var
#comfunc global IAlertDataCollector_put_EventLog                 35 int
#comfunc global IAlertDataCollector_get_SampleInterval           36 var
#comfunc global IAlertDataCollector_put_SampleInterval           37 int
#comfunc global IAlertDataCollector_get_Task                     38 var
#comfunc global IAlertDataCollector_put_Task                     39 wstr
#comfunc global IAlertDataCollector_get_TaskRunAsSelf            40 var
#comfunc global IAlertDataCollector_put_TaskRunAsSelf            41 int
#comfunc global IAlertDataCollector_get_TaskArguments            42 var
#comfunc global IAlertDataCollector_put_TaskArguments            43 wstr
#comfunc global IAlertDataCollector_get_TaskUserTextArguments    44 var
#comfunc global IAlertDataCollector_put_TaskUserTextArguments    45 wstr
#comfunc global IAlertDataCollector_get_TriggerDataCollectorSet  46 var
#comfunc global IAlertDataCollector_put_TriggerDataCollectorSet  47 wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IAlertDataCollector "{03837516-098B-11D8-9414-505054503030}"
#usecom global IAlertDataCollector IID_IAlertDataCollector "{}"
#comfunc global IAlertDataCollector_get_AlertThresholds          32 sptr
#comfunc global IAlertDataCollector_put_AlertThresholds          33 sptr
#comfunc global IAlertDataCollector_get_EventLog                 34 sptr
#comfunc global IAlertDataCollector_put_EventLog                 35 int
#comfunc global IAlertDataCollector_get_SampleInterval           36 sptr
#comfunc global IAlertDataCollector_put_SampleInterval           37 int
#comfunc global IAlertDataCollector_get_Task                     38 sptr
#comfunc global IAlertDataCollector_put_Task                     39 wstr
#comfunc global IAlertDataCollector_get_TaskRunAsSelf            40 sptr
#comfunc global IAlertDataCollector_put_TaskRunAsSelf            41 int
#comfunc global IAlertDataCollector_get_TaskArguments            42 sptr
#comfunc global IAlertDataCollector_put_TaskArguments            43 wstr
#comfunc global IAlertDataCollector_get_TaskUserTextArguments    44 sptr
#comfunc global IAlertDataCollector_put_TaskUserTextArguments    45 wstr
#comfunc global IAlertDataCollector_get_TriggerDataCollectorSet  46 sptr
#comfunc global IAlertDataCollector_put_TriggerDataCollectorSet  47 wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。