Win32 API 日本語リファレンス
ホーム › System.Performance › IDataCollectorCollection

IDataCollectorCollection

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID03837502-098b-11d8-9414-505054503030継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

DataCollector オブジェクトのコレクションを管理します。このインターフェイスを取得するには、IDataCollectorSet::DataCollectors プロパティにアクセスします。

メソッド 9

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

vtbl 7 HRESULT get_Count(INT* retVal)

コレクション内のデータコレクターの数を取得します。

retValINT*out現在の要素数を受け取るポインタである。
vtbl 8 HRESULT get_Item(VARIANT index, IDataCollector** collector)

要求されたデータコレクターをコレクションから取得します。

indexVARIANTin取得する要素のインデックスまたはキーを表す VARIANT を指定する。
collectorIDataCollector**out指定したデータコレクターを表す IDataCollector を受け取るポインタである。

解説(Remarks)

このプロパティは、オブジェクトの既定のプロパティです。

vtbl 9 HRESULT get__NewEnum(IUnknown** retVal)

列挙へのインターフェイスを取得します。(IDataCollectorCollection.get__NewEnum)

retValIUnknown**outコレクションを反復処理する列挙子(IEnumVARIANT)を受け取るポインタである。

解説(Remarks)

このプロパティは C++ プログラマーが使用します。

列挙の要素は、型が VT_UNKNOWN のバリアントです。IDataCollector インターフェイスを照会するには、バリアントの punkVal メンバーを使用します。

この列挙は、呼び出し時点でのコレクションのスナップショットです。

vtbl 10 HRESULT Add(IDataCollector* collector)

データコレクターをコレクションに追加します。

collectorIDataCollector*inoptionalこのコレクションに追加するデータコレクターの IDataCollector インターフェイス。

戻り値

成功した場合は S_OK を返します。次の表は、返される可能性のあるエラー値を示しています。

戻り値/値 説明
PLA_E_DCS_SINGLETON_REQUIRED
0x80300102
 データコレクターセットの現在の構成では、ちょうど 1 つのデータコレクターを含むことが必要です。
vtbl 11 HRESULT Remove(VARIANT collector)

データコレクターをコレクションから削除します。

collectorVARIANTinコレクションから削除するデータコレクターの 0 から始まるインデックス。バリアント型は VT_I4、VT_UI4、または VT_DISPATCH のいずれかです。

戻り値

成功した場合は S_OK を返します。

解説(Remarks)

バリアント型が VT_DISPATCH の場合は、削除する IDataCollector の IDispatch インターフェイスを渡します。

コレクターをコレクションから削除すると、そのコレクターはデータコレクターセットからも削除される点に注意してください。

vtbl 12 HRESULT Clear()

すべてのデータコレクターをコレクションから削除します。

戻り値

成功した場合は S_OK を返します。

解説(Remarks)

コレクターをコレクションから削除すると、それらのコレクターはデータコレクターセットからも削除される点に注意してください。

vtbl 13 HRESULT AddRange(IDataCollectorCollection* collectors)

1 つ以上のデータコレクターをコレクションに追加します。

collectorsIDataCollectorCollection*inoptionalこのコレクションに追加する 1 つ以上のデータコレクターのコレクションへの IDataCollectorCollection インターフェイス。

戻り値

成功した場合は S_OK を返します。次の表は、返される可能性のあるエラー値を示しています。

戻り値/値 説明
PLA_E_DCS_SINGLETON_REQUIRED
0x80300102
 データコレクターセットの現在の構成では、ちょうど 1 つのデータコレクターを含むことが必要です。
vtbl 14 HRESULT CreateDataCollectorFromXml(LPWSTR bstrXml, IValueMap** pValidation, IDataCollector** pCollector)

指定された XML を使用してデータコレクターを作成します。

bstrXmlLPWSTRin作成するデータコレクターの XML を含む文字列。XML 文字列の指定方法の詳細については、作成するデータコレクターの「解説」セクションを参照してください。
pValidationIValueMap**out値が有効でない各プロパティの検証エラーを取得するために使用する IValueMap インターフェイス。エラーがなかった場合、IValueMap::Count プロパティは 0 になります。
pCollectorIDataCollector**out新しく作成されたデータコレクターの IDataCollector インターフェイス。要求した実際のデータコレクターインターフェイスを取得するには、QueryInterface メソッドを呼び出します。

戻り値

成功した場合は S_OK を返します。

解説(Remarks)

XML の構文が有効であれば、1 つ以上のプロパティが有効でない場合でも、この API は S_OK を返します。値が有効なプロパティは設定されます。値が有効でないプロパティは、それぞれの既定値に設定されます。

発生したエラーを特定するには、各エラーについて IValueMapItem インターフェイスを取得します。IValueMapItem::Key プロパティには、エラーが発生した要素の XPath が格納されます(例: /AlertDataCollector/TaskArguments)。IValueMapItem::Value プロパティにはエラーに関連付けられた HRESULT が、IValueMapItem::Description プロパティにはエラーに関連付けられたメッセージテキストが格納されます。

通常、発生するエラーは次の HRESULT 値のいずれかになります。

エラー 説明
PLA_S_PROPERTY_IGNORED データコレクターに指定されたプロパティが含まれていないため、PLA はプロパティ要素を無視しました。
PLA_E_PROPERTY_CONFLICT プロパティが別のプロパティと競合しています。例えば、LogAppend と LogCircular の両方が VARIANT_TRUE になっている場合などです。

特定のデータコレクターについて IDataCollector インターフェイスを照会するには、次のいずれかのインターフェイス識別子を使用します。

データコレクターインターフェイス インターフェイス識別子
IApiTracingDataCollector IID_IApiTracingDataCollector
IAlertDataCollector IID_IAlertDataCollector
IConfigurationDataCollector IID_IConfigurationDataCollector
IPerformanceCounterDataCollector IID_IPerformanceCounterDataCollector
ITraceDataCollector IID_ITraceDataCollector
vtbl 15 HRESULT CreateDataCollector(DataCollectorType Type, IDataCollector** Collector)

指定された種類のデータコレクターを作成します。

TypeDataCollectorTypein作成するデータコレクターの種類。指定可能なデータコレクターの種類については、DataCollectorType 列挙型を参照してください。
CollectorIDataCollector**out新しく作成されたデータコレクターの IDataCollector インターフェイス。要求した実際のデータコレクターインターフェイスを取得するには、QueryInterface メソッドを呼び出します。

戻り値

成功した場合は S_OK を返します。

解説(Remarks)

特定のデータコレクターについて IDataCollector インターフェイスを照会するには、次のいずれかのインターフェイス識別子を使用します。

データコレクターインターフェイス インターフェイス識別子
IApiTracingDataCollector IID_IApiTracingDataCollector
IAlertDataCollector IID_IAlertDataCollector
IConfigurationDataCollector IID_IConfigurationDataCollector
IPerformanceCounterDataCollector IID_IPerformanceCounterDataCollector
ITraceDataCollector IID_ITraceDataCollector
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IDataCollectorCollection "{03837502-098B-11D8-9414-505054503030}"
#usecom global IDataCollectorCollection IID_IDataCollectorCollection "{}"
#comfunc global IDataCollectorCollection_get_Count                   7 var
#comfunc global IDataCollectorCollection_get_Item                    8 int,sptr
#comfunc global IDataCollectorCollection_get__NewEnum                9 sptr
#comfunc global IDataCollectorCollection_Add                         10 sptr
#comfunc global IDataCollectorCollection_Remove                      11 int
#comfunc global IDataCollectorCollection_Clear                       12
#comfunc global IDataCollectorCollection_AddRange                    13 sptr
#comfunc global IDataCollectorCollection_CreateDataCollectorFromXml  14 wstr,sptr,sptr
#comfunc global IDataCollectorCollection_CreateDataCollector         15 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。