Win32 API 日本語リファレンス
ホーム › UI.Xaml.Diagnostics › IXamlDiagnostics

IXamlDiagnostics

COM
📘 Microsoft Learn (日本語) · English
IID18c9e2b6-3f43-4116-9f2b-ff935d7770d2継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

XAML Diagnostics セッションを表します。

メソッド 8

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetDispatcher(IInspectable** ppDispatcher)

UI スレッド上で要素にアクセスするために使用されるコアディスパッチャーを取得します。

ppDispatcherIInspectable**outコアディスパッチャー。

戻り値

このメソッドが成功した場合、S_OK を返します。それ以外の場合は、HRESULT エラーコードを返します。

vtbl 4 HRESULT GetUiLayer(IInspectable** ppLayer)

ツリー内の要素を強調表示するために描画対象として使用できるビジュアル診断ルートを取得します。

ppLayerIInspectable**outビジュアル診断ルート。

戻り値

このメソッドが成功した場合、S_OK を返します。それ以外の場合は、HRESULT エラーコードを返します。

vtbl 5 HRESULT GetApplication(IInspectable** ppApplication)

アプリケーションのインスタンスを取得します。

ppApplicationIInspectable**outアプリケーション。

戻り値

このメソッドが成功した場合、S_OK を返します。それ以外の場合は、HRESULT エラーコードを返します。

vtbl 6 HRESULT GetIInspectableFromHandle(ULONGLONG instanceHandle, IInspectable** ppInstance)

XAML Diagnostics キャッシュから IInspectable を取得します。

instanceHandleULONGLONGinオブジェクトへのハンドル。
ppInstanceIInspectable**outIInspectable としてのオブジェクト。

戻り値

このメソッドが成功した場合、S_OK を返します。それ以外の場合は、HRESULT エラーコードを返します。

解説(Remarks)

XAML Diagnostics が要素への参照を保持していない場合、このメソッドは失敗します。

vtbl 7 HRESULT GetHandleFromIInspectable(IInspectable* pInstance, ULONGLONG* pHandle)

IInspectable の InstanceHandle 表現を取得します。

pInstanceIInspectable*inIInspectable としてのオブジェクトのインスタンス。
pHandleULONGLONG*outオブジェクトへのハンドル。

戻り値

このメソッドが成功した場合、S_OK を返します。それ以外の場合は、HRESULT エラーコードを返します。

vtbl 8 HRESULT HitTest(RECT rect, DWORD* pCount, ULONGLONG** ppInstanceHandles)

指定した矩形内に含まれるビジュアルツリー内のすべての要素を取得します。

rectRECTinヒットテストを行う領域。
pCountDWORD*out配列のサイズ。
ppInstanceHandlesULONGLONG**outすべての要素を含む配列。

戻り値

このメソッドが成功した場合、S_OK を返します。それ以外の場合は、HRESULT エラーコードを返します。

解説(Remarks)

このメソッドは XAML ビジュアルツリーに対してヒットテストを実行し、ヒットテストに対して有効か非表示かにかかわらず、すべての要素を返します。折りたたまれた要素はレイアウトに関与しないため、このメソッドでは返されません。このメソッドを呼び出す前に AdviseVisualTreeChange を呼び出しておく必要があります。要素が返されるために rect 領域内へ完全に収まっている必要はありません。

vtbl 9 HRESULT RegisterInstance(IInspectable* pInstance, ULONGLONG* pInstanceHandle)

IInspectable を XAML Diagnostics キャッシュに追加し、そのオブジェクトに対して新しく作成された InstanceHandle を返します。

pInstanceIInspectable*inオブジェクトのインスタンス。
pInstanceHandleULONGLONG*outオブジェクトへのハンドル。

戻り値

このメソッドが成功した場合、S_OK を返します。それ以外の場合は、HRESULT エラーコードを返します。

vtbl 10 HRESULT GetInitializationData(LPWSTR* pInitializationData)

XAML Diagnostics に渡された初期化データを取得します。

pInitializationDataLPWSTR*out初期化データ。

戻り値

このメソッドが成功した場合、S_OK を返します。それ以外の場合は、HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IXamlDiagnostics "{18C9E2B6-3F43-4116-9F2B-FF935D7770D2}"
#usecom global IXamlDiagnostics IID_IXamlDiagnostics "{}"
#comfunc global IXamlDiagnostics_GetDispatcher              3 sptr
#comfunc global IXamlDiagnostics_GetUiLayer                 4 sptr
#comfunc global IXamlDiagnostics_GetApplication             5 sptr
#comfunc global IXamlDiagnostics_GetIInspectableFromHandle  6 int64,sptr
#comfunc global IXamlDiagnostics_GetHandleFromIInspectable  7 sptr,var
#comfunc global IXamlDiagnostics_HitTest                    8 int,var,var
#comfunc global IXamlDiagnostics_RegisterInstance           9 sptr,var
#comfunc global IXamlDiagnostics_GetInitializationData      10 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。