IBM Security Access Manager for Enterprise Single Sign-On, バージョン 8.2

ウィンドウ・コントローラー・クラス

以下の各表に、AccessStudio ウィンドウ・コントローラー・クラスのプラグイン API の仕様を示します。

GetHWNDFromXPath([in]BSTR bstrWndXPath)

説明	特定のシグニチャー・ストリングについて、一致するウィンドウを評価してそれを戻します。
詳細
パラメーター	[IN] bstrWndXPath - 評価するウィンドウのシグニチャー。
戻り	見つかったウィンドウを表す符号なし long。ウィンドウが見つからない場合は `0`。

GetWindowText([in]ULONG hWnd)

説明	ウィンドウに対する特定のハンドルについて、そのテキストを戻します。注: 戻されるテキストの最大長は、500 文字です。この関数は、呼び出し側プロセスと同じプロセスでのみ機能します。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。
戻り	ウィンドウにテキストがない場合、またはウィンドウが見つからないか、ウィンドウが別のプロセスにある場合は、空ストリング。

GetWindowRect([in]ULONG hWnd, [out]long* lTLX, [out]long* lTLY, [out]long* lBRX, [out]long* lBRY)

説明	ウィンドウ・ハンドルを通じて指定されたウィンドウの画面座標を戻します。注: この API は、ウィンドウ・ハンドルが正しくない場合に例外をスローします。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。 [OUT] lTLX - 左上隅の x 座標。 [OUT] lTLY - 左上隅の y 座標。 [OUT] lBRX - 右下隅の x 座標。 [OUT] lBRY - 右下隅の y 座標。
戻り	なし

GetWindowClientRect([in]ULONG hWnd, [out]long* lTLX, [out]long* lTLY, [out]long* lBRX, [out]long* lBRY)

説明	ウィンドウ・ハンドルを通じて指定されたウィンドウのクライアント座標を戻します。注: この API は、ウィンドウ・ハンドルが正しくない場合に例外をスローします。
詳細
パラメーター	[IN] hWnd: ウィンドウに対するハンドル (符号なし long)。 [OUT] lTLX - 左上隅の x 座標。 [OUT] lTLY - 左上隅の y 座標。 [OUT] lBRX - 右下隅の x 座標。 [OUT] lBRY - 右下隅の y 座標。
戻り	なし

GetWindowControlID([in]ULONG hWnd)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウについて、その制御 ID を戻します。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。
戻り	制御 ID を表す符号なし long。

GetWindowStyle([in]ULONG hWnd)

説明	特定のウィンドウについて、そのウィンドウ・スタイルを表す符号なし long を戻します。注: 戻り値の各ビットは、フラグを表します。各ビットの意味を理解するには、Microsoft Windows スタイルの資料を確認してください。
詳細
パラメーター	[IN] hWnd: ウィンドウに対するハンドル (符号なし long)。
戻り	ウィンドウ・スタイルを表す符号なし long。ウィンドウが見つからない場合は、`0` が戻されます。

GetWindowStyleEx([in]ULONG hWnd)

説明	特定のウィンドウについて、その拡張ウィンドウ・スタイルを表す符号なし long を戻します。注: 戻り値の各ビットは、フラグを表します。各ビットの意味を理解するには、Microsoft Windows スタイルの資料を確認してください。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。
戻り	ウィンドウの拡張スタイルを表す符号なし long。ウィンドウが見つからない場合は、`0` が戻されます。

GetWindowParent([in]ULONG hWnd)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウについて、その親ウィンドウを戻します。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。
戻り	ウィンドウが子ウィンドウの場合、戻り値は、親ウィンドウに対するハンドルです。ウィンドウが最上位ウィンドウの場合、戻り値は、所有者ウィンドウに対するハンドルです。ウィンドウが最上位の所有されないウィンドウの場合、または関数が失敗した場合、戻り値は `0` です。

GetWindowOwner([in]ULONG hWnd)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウについて、その所有者ウィンドウを戻します。
詳細
パラメーター	[IN] hWnd: ウィンドウに対するハンドル (符号なし long)。
戻り	所有者ウィンドウを取得します。ウィンドウに所有者がない場合、またはウィンドウ・ハンドルが正しくない場合。

GetWindowRoot([in]ULONG hWnd)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウについて、親ウィンドウのチェーンを移動することにより、ルート・ウィンドウを戻します。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。
戻り	戻り値は、ルート・ウィンドウ (符号なし long) です。ルート・ウィンドウがない場合は、`0` が戻されます。

GetWindowClass([in]ULONG hWnd)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウについて、そのウィンドウ・クラスを戻します。注: この API は、ウィンドウに対するハンドルが正しくない場合に例外をスローします。クラス名は、256 文字の長さが可能です。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。
戻り	ウィンドウ・クラスを表すストリング。

GetWindowThreadID([in]ULONG hWnd)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウについて、そのスレッド ID を戻します。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。
戻り	スレッド ID を表す符号なし long。ウィンドウ・ハンドルが正しくない場合は、`0` が戻されます。

GetWindowProcessID([in]ULONG hWnd)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウについて、そのプロセス ID を戻します。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。
戻り	プロセス ID を表す符号なし long。ウィンドウ・ハンドルが正しくない場合は、`0` が戻されます。

GetWindowEnabled([in]ULONG hWnd)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウについて、それが使用可能であるかどうかを戻します。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。
戻り	ウィンドウが使用可能の場合は、VARIANT_TRUE (`-1`)。ウィンドウが使用不可、またはウィンドウ・ハンドルが正しくない場合は、VARIANT_FALSE (`0`)。

GetWindowVisiblility([in]ULONG hWnd)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウについて、ウィンドウが可視であるかどうかを戻します。注: ウィンドウの可視性の状態は、WS_VISIBLE スタイル・ビットによって示されます。WS_VISIBLE が設定されると、ウィンドウが表示され、ウィンドウに WS_VISIBLE スタイルが設定されている限り、ウィンドウへの後続の描画が表示されます。ウィンドウがその他のウィンドウによって覆い隠されている場合、またはウィンドウがその親ウィンドウによって切り取られている場合は、 WS_VISIBLE スタイルが設定されていても、ウィンドウへの描画は表示されません。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。
戻り	ウィンドウが可視の場合は、VARIANT_TRUE (`-1`)。ウィンドウが不可視の場合、またはウィンドウ・ハンドルが無効な場合は、VARIANT_FALSE (`0`)。

EnableWindow([in]ULONG hWnd, [in]VARIANT_BOOL bEnable)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウについて、そのウィンドウを使用可能または使用不可にします。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。 [IN] bEnable- 使用可能にする場合は VARIANT_TRUE (`-1`)、使用不可にする場合は VARIANT_FALSE (`0`)。
戻り	なし

ShowWindow([in]ULONG hWnd, [in]VARIANT_BOOL bShow)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウについて、そのウィンドウを表示または非表示にします。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。 [IN] bShow - 表示する場合は VARIANT_TRUE (`-1`)、非表示にする場合は VARIANT_FALSE (`0`)。
戻り	なし

CloseWindow([in]ULONG hWnd)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウについて、そのウィンドウを閉じます。注: ウィンドウ・ハンドルが正しくないか、他の何らかの理由でウィンドウを閉じることができない場合、API は例外をスローします。
詳細
パラメーター	[IN] hWnd - 閉じるウィンドウに対するハンドル (符号なし long)。
戻り	なし

ClickWindow([in]ULONG hWnd, [in, optional]long nX, [in, optional]long nY)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウについて、指定されたオプションの位置でウィンドウをクリックします。注: この API は、正しくないウィンドウ・ハンドルに対して例外をスローします。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。 [IN] nX - ウィンドウの左上隅を基準にして指定されたオプションの X 座標。指定しない場合は、ウィンドウの中央が想定されます。 [IN] nY - ウィンドウの左上隅を基準にして指定されたオプションの Y 座標。指定しない場合は、ウィンドウの中央が想定されます。
戻り	なし

FocusWindow([in]ULONG hWnd)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウの場合、ウィンドウをフォーカスします。注: この API は、正しくないウィンドウ・ハンドルに対して例外をスローします。
詳細	位置 - 1, 5 にある非クライアント領域をクリックすることにより、ウィンドウがフォーカスされます。この API は、タイトル・バーを備えた最上位ウィンドウでのみ機能します。
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。
戻り	なし

SetWindowText([in]ULONG hWnd, [in]BSTR bstrText)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウについて、指定されたテキストを試行して設定します。注: この API は、正しくないウィンドウ・ハンドルに対して例外をスローします。この API は、テキストを設定する標準のウィンドウ・メソッドを呼び出し、キーボード・シミュレーションは実行しません。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。 [IN] bstrText - 設定するストリング。
戻り	なし

GetChildWindows([in]ULONG hWnd)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウについて、その直接の子ウィンドウをすべて取得します。注: この API は、正しくないウィンドウ・ハンドルに対して例外をスローします。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。
戻り	符号なし long の配列。それぞれが子ウィンドウ・ハンドルを表します。

EnableWindowMenu([in]ULONG hWnd, [in]BSTR bstrMenuPath, [in]VARIANT_BOOL bEnable)

説明	ウィンドウ・ハンドルを通じて指定された特定のウィンドウについて、メニュー・パスを通じて指定されたメニュー項目を使用可能にします。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル (符号なし long)。 [IN] bstrMenuPath - ルートからのメニュー・パス (例: File/Exit)。 [IN] bEnable- 使用可能にする場合は VARIANT_TRUE (`-1`)、使用不可にする場合は VARIANT_FALSE (`0`)。
戻り	なし

GetListViewAccessor([in] ULONG hWnd,[out,retval] IListControl** pListObj);

説明	リスト・ビューに対するウィンドウ・ハンドルが付与されたリスト・ビュー・コントロールのより詳細な情報を取得するためのアクセサー・オブジェクトを提供します。注: アクセサー・オブジェクトは、行と列の数や、特定の行と列の組み合わせで提供されるテキストなどの情報を取得するために使用します (ListControl アクセサー・オブジェクトの詳細を参照してください)。
詳細
パラメーター	[IN] hWnd - リスト・ビュー・ウィンドウに対するハンドル
戻り	ListControl アクセサー・オブジェクト。ウィンドウがリスト・ビューでない場合、またはウィンドウが見つからない場合、戻されるオブジェクトはヌルです。

SetWindowPosition([in] ULONG hWnd, [in] LONG nX, [in] LONG nY,[out,retval] int* bSuccess)

説明	ウィンドウの位置を、親ウィンドウのクライアント域を基準とした位置に設定します。注: 指定したウィンドウが最上位にある場合は、デスクトップを親として位置が決定されます。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル [IN] nX - ウィンドウの左上隅のクライアント座標での x 座標。 [IN] nY - ウィンドウの左上隅のクライアント座標での y 座標。
戻り	OK の場合は `1` エラーの場合は `0`

GetWindowPosition([in] ULONG hWnd, [out] VARIANT* nX, [out] VARIANT* nY, [out] VARIANT* cx, [out] VARIANT* cy)

説明	親ウィンドウのクライアント域を基準としたウィンドウの位置を取得します。指定したウィンドウが最上位にある場合は、デスクトップを親として位置が決定されます。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル [OUT] nX - ウィンドウの左上隅の x 座標。 [OUT] nY - ウィンドウの左上隅の y 座標。 [OUT] cx - ウィンドウの幅。 [OUT] cy - ウィンドウの高さ。
戻り	なし

SimpleClickWindow([in] ULONG hWnd);

説明	クリック・メッセージをウィンドウに送信します。ウィンドウには WM_LBUTTONDOWN および WM_LBUTTONUP ウィンドウ・メッセージが送信されます。これはどちらもウィンドウの中心を指します。
詳細
パラメーター	[IN] hWnd - ウィンドウに対するハンドル
戻り	なし

GetFFBasicAuthServerLabel([in] ULONG hWnd, [out, retval] BSTR * label)

説明	Firefox 基本認証ダイアログからラベル・ストリングを取得します。
詳細
パラメーター
戻り	サーバー名を抽出して認証サービスを特定するために使用できるラベル・テキスト。

GetIAccessibleFromWindow([in] ULONG hWnd, [out, retval] IDispatch** pRet)

説明	ウィンドウ・ハンドルから IAccessible インターフェースを取得します。このインターフェースを使用して、ウィンドウがアクセシビリティー・サポートのために提供している情報をさらに照会することができます。
詳細
パラメーター	[IN] hWnd - IAccessible インターフェースが取り出されるウィンドウに対するハンドル
戻り	指定したウィンドウの IAccessible インターフェース (提供されている場合)。提供されていない場合は NULL が戻されます。

フィードバック