Win32 API 日本語リファレンス
ホーム › UI.Accessibility › IUIAutomationWindowPattern

IUIAutomationWindowPattern

COM
📘 Microsoft Learn (日本語) · English
IID0faef453-9208-43ef-bbb2-3b485177864f継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ウィンドウの基本的な機能へのアクセスを提供します。

解説(Remarks)

このコントロールパターンをサポートするコントロールの例には、トップレベルのアプリケーションウィンドウ、マルチドキュメントインターフェイス (MDI) の子ウィンドウ、モーダルダイアログボックスなどがあります。

メソッド 15

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

vtbl 3 HRESULT Close()

ウィンドウを閉じます。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。失敗した場合は HRESULT エラーコードを返します。

解説(Remarks)

分割ペインコントロールに対して呼び出された場合、このメソッドはペインを閉じ、関連する分割を削除します。実装によっては、他のすべてのペインも閉じることがあります。

vtbl 4 HRESULT WaitForInputIdle(INT milliseconds, BOOL* success)

指定された時間、または関連するプロセスがアイドル状態になるまでのいずれか早い方まで、呼び出し元のコードをブロックさせます。(IUIAutomationWindowPattern.WaitForInputIdle)

millisecondsINTin関連するプロセスがアイドル状態になるまで待機する時間 (ミリ秒単位)。
successBOOL*out結果を受け取ります。ウィンドウがアイドル状態になった場合は TRUE、タイムアウトが発生した場合は FALSE となります。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。失敗した場合は HRESULT エラーコードを返します。

vtbl 5 HRESULT SetWindowVisualState(WindowVisualState state)

ウィンドウを最小化、最大化、または元に戻します。

stateWindowVisualStateinウィンドウの新しい表示状態。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。失敗した場合は HRESULT エラーコードを返します。

vtbl 6 HRESULT get_CurrentCanMaximize(BOOL* retVal)

ウィンドウを最大化できるかどうかを示します。(IUIAutomationWindowPattern.get_CurrentCanMaximize)

retValBOOL*outウィンドウを最大化できるかどうかを示す論理値を受け取るポインタである。
vtbl 7 HRESULT get_CurrentCanMinimize(BOOL* retVal)

ウィンドウを最小化できるかどうかを示します。(IUIAutomationWindowPattern.get_CurrentCanMinimize)

retValBOOL*outウィンドウを最小化できるかどうかを示す論理値を受け取るポインタである。
vtbl 8 HRESULT get_CurrentIsModal(BOOL* retVal)

ウィンドウがモーダルかどうかを示します。(IUIAutomationWindowPattern.get_CurrentIsModal)

retValBOOL*outウィンドウがモーダルかどうかを示す論理値を受け取るポインタである。
vtbl 9 HRESULT get_CurrentIsTopmost(BOOL* retVal)

ウィンドウが z オーダーで最前面の要素かどうかを示します。(IUIAutomationWindowPattern.get_CurrentIsTopmost)

retValBOOL*outウィンドウが最前面(トップモスト)かどうかを示す論理値を受け取るポインタである。
vtbl 10 HRESULT get_CurrentWindowVisualState(WindowVisualState* retVal)

ウィンドウの表示状態、すなわち通常・最大化・最小化のいずれの状態にあるかを取得します。

retValWindowVisualState*outウィンドウの現在の表示状態を示す WindowVisualState 値を受け取るポインタである。
vtbl 11 HRESULT get_CurrentWindowInteractionState(WindowInteractionState* retVal)

ユーザー操作の観点から、ウィンドウの現在の状態を取得します。

retValWindowInteractionState*outウィンドウの現在の操作可能状態を示す WindowInteractionState 値を受け取るポインタである。
vtbl 12 HRESULT get_CachedCanMaximize(BOOL* retVal)

ウィンドウを最大化できるかどうかを示すキャッシュされた値を取得します。

retValBOOL*outキャッシュされた、ウィンドウを最大化できるかどうかを示す論理値を受け取るポインタである。
vtbl 13 HRESULT get_CachedCanMinimize(BOOL* retVal)

ウィンドウを最小化できるかどうかを示すキャッシュされた値を取得します。

retValBOOL*outキャッシュされた、ウィンドウを最小化できるかどうかを示す論理値を受け取るポインタである。
vtbl 14 HRESULT get_CachedIsModal(BOOL* retVal)

ウィンドウがモーダルかどうかを示すキャッシュされた値を取得します。

retValBOOL*outキャッシュされた、ウィンドウがモーダルかどうかを示す論理値を受け取るポインタである。
vtbl 15 HRESULT get_CachedIsTopmost(BOOL* retVal)

ウィンドウが z オーダーで最前面の要素かどうかを示すキャッシュされた値を取得します。

retValBOOL*outキャッシュされた、ウィンドウが最前面かどうかを示す論理値を受け取るポインタである。
vtbl 16 HRESULT get_CachedWindowVisualState(WindowVisualState* retVal)

ウィンドウの表示状態、すなわち通常・最大化・最小化のいずれの状態にあるかを示すキャッシュされた値を取得します。

retValWindowVisualState*outキャッシュされた、ウィンドウの表示状態を示す WindowVisualState 値を受け取るポインタである。
vtbl 17 HRESULT get_CachedWindowInteractionState(WindowInteractionState* retVal)

ユーザー操作の観点から、ウィンドウの現在の状態を示すキャッシュされた値を取得します。

retValWindowInteractionState*outキャッシュされた、ウィンドウの操作可能状態を示す WindowInteractionState 値を受け取るポインタである。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUIAutomationWindowPattern "{0FAEF453-9208-43EF-BBB2-3B485177864F}"
#usecom global IUIAutomationWindowPattern IID_IUIAutomationWindowPattern "{}"
#comfunc global IUIAutomationWindowPattern_Close                              3
#comfunc global IUIAutomationWindowPattern_WaitForInputIdle                   4 int,var
#comfunc global IUIAutomationWindowPattern_SetWindowVisualState               5 int
#comfunc global IUIAutomationWindowPattern_get_CurrentCanMaximize             6 var
#comfunc global IUIAutomationWindowPattern_get_CurrentCanMinimize             7 var
#comfunc global IUIAutomationWindowPattern_get_CurrentIsModal                 8 var
#comfunc global IUIAutomationWindowPattern_get_CurrentIsTopmost               9 var
#comfunc global IUIAutomationWindowPattern_get_CurrentWindowVisualState       10 var
#comfunc global IUIAutomationWindowPattern_get_CurrentWindowInteractionState  11 var
#comfunc global IUIAutomationWindowPattern_get_CachedCanMaximize              12 var
#comfunc global IUIAutomationWindowPattern_get_CachedCanMinimize              13 var
#comfunc global IUIAutomationWindowPattern_get_CachedIsModal                  14 var
#comfunc global IUIAutomationWindowPattern_get_CachedIsTopmost                15 var
#comfunc global IUIAutomationWindowPattern_get_CachedWindowVisualState        16 var
#comfunc global IUIAutomationWindowPattern_get_CachedWindowInteractionState   17 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。