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

IApiTracingDataCollector

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

公式ドキュメント

Kernel32.dll、Advapi32.dll、Gdi32.dll、User32.dll への Win32 呼び出しをログに記録します。

解説(Remarks)

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

<ApiTracingDataCollector>
    <ExcludeApis/>
    <ExePath/> 
    <IncludeApis/>
    <IncludeModules/>
    <LogApiNamesOnly/>
    <LogApisRecursively/>
    <LogFilePath/>
</ApiTracingDataCollector>

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

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

メソッド 14

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

vtbl 32 HRESULT get_LogApiNamesOnly(VARIANT_BOOL* logapinames)

PLA が関数名のみをログに記録するかどうかを示す値を取得または設定します。(Get)

logapinamesVARIANT_BOOL*out現在のAPI 名のみをログ記録するかどうかを受け取るポインタである。
vtbl 33 HRESULT put_LogApiNamesOnly(VARIANT_BOOL logapinames)

PLA が関数名のみをログに記録するかどうかを示す値を取得または設定します。(Put)

logapinamesVARIANT_BOOLinAPI 名のみをログ記録するかどうかを設定する。
vtbl 34 HRESULT get_LogApisRecursively(VARIANT_BOOL* logrecursively)

アプリケーションによって直接インポートされた呼び出しを API トレースがログに記録するかどうかを示す値を取得または設定します。(Get)

logrecursivelyVARIANT_BOOL*out現在のAPI を再帰的にログ記録するかどうかを受け取るポインタである。

解説(Remarks)

このプロパティは x86 アーキテクチャに対してのみ意味を持ちます。

vtbl 35 HRESULT put_LogApisRecursively(VARIANT_BOOL logrecursively)

アプリケーションによって直接インポートされた呼び出しを API トレースがログに記録するかどうかを示す値を取得または設定します。(Put)

logrecursivelyVARIANT_BOOLinAPI を再帰的にログ記録するかどうかを設定する。

解説(Remarks)

このプロパティは x86 アーキテクチャに対してのみ意味を持ちます。

vtbl 36 HRESULT get_ExePath(LPWSTR* exepath)

API 呼び出しをトレースする対象の実行可能ファイルへのパスを取得または設定します。(Get)

exepathLPWSTR*out現在の対象実行ファイルのパスを受け取るポインタである。

解説(Remarks)

実行可能ファイルが現在実行中の場合、トレースはこの時点ではなく、次にその実行可能ファイルが実行されるときに行われます。

vtbl 37 HRESULT put_ExePath(LPWSTR exepath)

API 呼び出しをトレースする対象の実行可能ファイルへのパスを取得または設定します。(Put)

exepathLPWSTRin対象実行ファイルのパスを設定する。

解説(Remarks)

実行可能ファイルが現在実行中の場合、トレースはこの時点ではなく、次にその実行可能ファイルが実行されるときに行われます。

vtbl 38 HRESULT get_LogFilePath(LPWSTR* logfilepath)

API トレースデータを格納するログファイルの名前を取得または設定します。(Get)

logfilepathLPWSTR*out現在のログファイルのパスを受け取るポインタである。
vtbl 39 HRESULT put_LogFilePath(LPWSTR logfilepath)

API トレースデータを格納するログファイルの名前を取得または設定します。(Put)

logfilepathLPWSTRinログファイルのパスを設定する。
vtbl 40 HRESULT get_IncludeModules(SAFEARRAY** includemodules)

トレースに含めるモジュールの一覧を取得または設定します。(Get)

includemodulesSAFEARRAY**out現在の対象に含めるモジュールの一覧を受け取るポインタである。

解説(Remarks)

このプロパティを設定しない場合、トレースには次のモジュールが含まれます。

このプロパティは、トレースをこれらの DLL のサブセットに限定します。たとえば、このプロパティを使用して、トレースを Kernel32.dll と Advapi32.dll のみに限定できます。
vtbl 41 HRESULT put_IncludeModules(SAFEARRAY* includemodules)

トレースに含めるモジュールの一覧を取得または設定します。(Put)

includemodulesSAFEARRAY*in対象に含めるモジュールの一覧を設定する。

解説(Remarks)

このプロパティを設定しない場合、トレースには次のモジュールが含まれます。

このプロパティは、トレースをこれらの DLL のサブセットに限定します。たとえば、このプロパティを使用して、トレースを Kernel32.dll と Advapi32.dll のみに限定できます。
vtbl 42 HRESULT get_IncludeApis(SAFEARRAY** includeapis)

トレースに含める関数の一覧を取得または設定します。(Get)

includeapisSAFEARRAY**out現在の対象に含める API の一覧を受け取るポインタである。

解説(Remarks)

このプロパティを使用して、PLA がログに記録する関数を、この関数の一覧のみに限定できます。

vtbl 43 HRESULT put_IncludeApis(SAFEARRAY* includeapis)

トレースに含める関数の一覧を取得または設定します。(Put)

includeapisSAFEARRAY*in対象に含める API の一覧を設定する。

解説(Remarks)

このプロパティを使用して、PLA がログに記録する関数を、この関数の一覧のみに限定できます。

vtbl 44 HRESULT get_ExcludeApis(SAFEARRAY** excludeapis)

トレースから除外する関数の一覧を取得または設定します。(Get)

excludeapisSAFEARRAY**out現在の対象から除外する API の一覧を受け取るポインタである。
vtbl 45 HRESULT put_ExcludeApis(SAFEARRAY* excludeapis)

トレースから除外する関数の一覧を取得または設定します。(Put)

excludeapisSAFEARRAY*in対象から除外する API の一覧を設定する。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IApiTracingDataCollector "{0383751A-098B-11D8-9414-505054503030}"
#usecom global IApiTracingDataCollector IID_IApiTracingDataCollector "{}"
#comfunc global IApiTracingDataCollector_get_LogApiNamesOnly     32 var
#comfunc global IApiTracingDataCollector_put_LogApiNamesOnly     33 int
#comfunc global IApiTracingDataCollector_get_LogApisRecursively  34 var
#comfunc global IApiTracingDataCollector_put_LogApisRecursively  35 int
#comfunc global IApiTracingDataCollector_get_ExePath             36 var
#comfunc global IApiTracingDataCollector_put_ExePath             37 wstr
#comfunc global IApiTracingDataCollector_get_LogFilePath         38 var
#comfunc global IApiTracingDataCollector_put_LogFilePath         39 wstr
#comfunc global IApiTracingDataCollector_get_IncludeModules      40 var
#comfunc global IApiTracingDataCollector_put_IncludeModules      41 var
#comfunc global IApiTracingDataCollector_get_IncludeApis         42 var
#comfunc global IApiTracingDataCollector_put_IncludeApis         43 var
#comfunc global IApiTracingDataCollector_get_ExcludeApis         44 var
#comfunc global IApiTracingDataCollector_put_ExcludeApis         45 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。