GetRegionData 関数 (wingdi.h)

GetRegionData 関数は、指定されたバッファーに領域を記述するデータを格納します。このデータには、領域を構成する四角形のディメンションが含まれます。

構文

DWORD GetRegionData(
  [in]  HRGN      hrgn,
  [in]  DWORD     nCount,
  [out] LPRGNDATA lpRgnData
);

[in] hrgn

リージョンへのハンドル。

[in] nCount

lpRgnData バッファーのサイズ (バイト単位)。

[out] lpRgnData

情報を受け取る RGNDATA 構造体へのポインター。リージョンのディメンションは論理単位です。このパラメーターが NULL の場合、戻り値にはリージョンデータに必要なバイト数が含まれます。

関数が成功し、 nCount で 適切なバイト数が指定されている場合、戻り値は実際に使用されたバイト数 ( nCount 以下) と等しくなります。

lpRgnData が NULL の場合、戻り値は必要なバイト数になります。

関数が失敗した場合、戻り値は 0 になります。

hrgn が無効であることが原因でエラーが発生した場合、GetLastError はERROR_INVALID_HANDLEを返します。それ以外の場合、 GetLastError はERROR_INVALID_PARAMETER を返します。

nCount が小さすぎると、関数は失敗します。

GetRegionData 関数は、ExtCreateRegion 関数と組み合わせて使用されます。

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	wingdi.h (Windows.h を含む)
Library	Gdi32.lib
[DLL]	Gdi32.dll