IAccessibilityDockingService::GetAvailableSize メソッド (shobjidl.h)

アクセシビリティ ウィンドウを表示するために特定の画面で使用できるディメンションを取得します。

構文

HRESULT GetAvailableSize(
  [in]  HMONITOR hMonitor,
  [out] UINT     *pcxFixed,
  [out] UINT     *pcyMax
);

パラメーター

[in] hMonitor

種類: HMONITOR

使用可能なドッキング サイズを取得するモニターのハンドル。 HMONITOR を取得する方法については、「MonitorFromWindow」を参照してください。

[out] pcxFixed

型: UINT*

このメソッドが正常に返されると、このパラメーターは、指定されたモニターにドッキングするために使用できる固定幅 (物理ピクセル単位) を受け取ります。 このモニターにドッキングされたウィンドウはすべて、この幅に合わせてサイズ変更されます。

メソッドが失敗した場合、この値は 0 に設定されます。

この値が NULL の場合、アクセス違反が発生します。

[out] pcyMax

型: UINT*

このメソッドが正常に返されると、このパラメーターは、指定されたモニターのドッキング されたウィンドウで使用できる最大高さ (物理ピクセル単位) を受け取ります。

メソッドが失敗した場合、この値は 0 に設定されます。

この値が NULL の場合、アクセス違反が発生します。

戻り値

型: HRESULT

次のような標準の戻り値を返します。

リターン コード	説明
S_OK	メソッドが成功しました。
HRESULT_FROM_WIN32(ERROR_INVALID_MONITOR_HANDLE)	hMonitor で指定されたモニターは、ドッキングをサポートしていません。

注釈

使用するタイミング

ドッキングされたアクセシビリティ ウィンドウは、任意の画面で使用できる領域の量に制限されます。 そのため、アクセシビリティ ウィンドウをドッキングする前に、この関数を呼び出して使用可能なディメンションを取得します。 Windows ストア アプリが 768 ピクセル未満の垂直画面ピクセルにアクセスできるようにするウィンドウをドッキングすることはできません。

例

この例では、このメソッドを使用しています。

 IAccessibilityDockingService *pDockingService;
 
 HRESULT hr = CoCreateInstance(CLSID_AccessibilityDockingService, CLSCTX_INPROV_SERVER, nullptr, IID_PPV_ARGS(&pDockingService));
 if (SUCCEEDED(hr)) 
 {
     UINT uMaxHeight;
     UINT uFixedWidth;

     HMONITOR hMonitor = MonitorFromWindow(_hwndMyApplication, MONITOR_DEFAULTTONULL);
     if (hMonitor != nullptr)
     {
         hr = pDockingService->GetAvailableSize(hMonitor, &uMaxHeight, &uFixedWidth);
     }
 }

要件

要件	値
サポートされている最小のクライアント	Windows 8 [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2012 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	shobjidl.h

こちらもご覧ください

IAccessibilityDockingService