GetRegionData

関数

領域を構成する矩形群のデータを取得する。

DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// GDI32.dll
#include <windows.h>

DWORD GetRegionData(
    HRGN hrgn,
    DWORD nCount,
    RGNDATA* lpRgnData   // optional
);

パラメーター

名前	型	方向	説明
hrgn	HRGN	in	リージョンへのハンドル。
nCount	DWORD	in	lpRgnData バッファーのサイズ (バイト単位)。
lpRgnData	RGNDATA*	outoptional	情報を受け取る RGNDATA 構造体へのポインター。リージョンの寸法は論理単位で表されます。このパラメーターが NULL の場合、戻り値にはリージョンデータに必要なバイト数が格納されます。

戻り値の型: DWORD

公式ドキュメント

GetRegionData 関数は、リージョンを記述するデータで指定されたバッファーを埋めます。このデータには、リージョンを構成する四角形の寸法が含まれます。

戻り値

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

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

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

失敗の原因が hrgn が無効であることによる場合、GetLastError は ERROR_INVALID_HANDLE を返します。それ以外の場合、GetLastError は ERROR_INVALID_PARAMETER を返します。

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

解説(Remarks)

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// GDI32.dll
#include <windows.h>

DWORD GetRegionData(
    HRGN hrgn,
    DWORD nCount,
    RGNDATA* lpRgnData   // optional
);

[DllImport("GDI32.dll", ExactSpelling = true)]
static extern uint GetRegionData(
    IntPtr hrgn,   // HRGN
    uint nCount,   // DWORD
    IntPtr lpRgnData   // RGNDATA* optional, out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function GetRegionData(
    hrgn As IntPtr,   ' HRGN
    nCount As UInteger,   ' DWORD
    lpRgnData As IntPtr   ' RGNDATA* optional, out
) As UInteger
End Function

' hrgn : HRGN
' nCount : DWORD
' lpRgnData : RGNDATA* optional, out
Declare PtrSafe Function GetRegionData Lib "gdi32" ( _
    ByVal hrgn As LongPtr, _
    ByVal nCount As Long, _
    ByVal lpRgnData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetRegionData = ctypes.windll.gdi32.GetRegionData
GetRegionData.restype = wintypes.DWORD
GetRegionData.argtypes = [
    wintypes.HANDLE,  # hrgn : HRGN
    wintypes.DWORD,  # nCount : DWORD
    ctypes.c_void_p,  # lpRgnData : RGNDATA* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetRegionData = Fiddle::Function.new(
  lib['GetRegionData'],
  [
    Fiddle::TYPE_VOIDP,  # hrgn : HRGN
    -Fiddle::TYPE_INT,  # nCount : DWORD
    Fiddle::TYPE_VOIDP,  # lpRgnData : RGNDATA* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn GetRegionData(
        hrgn: *mut core::ffi::c_void,  // HRGN
        nCount: u32,  // DWORD
        lpRgnData: *mut RGNDATA  // RGNDATA* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("GDI32.dll")]
public static extern uint GetRegionData(IntPtr hrgn, uint nCount, IntPtr lpRgnData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetRegionData' -Namespace Win32 -PassThru
# $api::GetRegionData(hrgn, nCount, lpRgnData)

#uselib "GDI32.dll"
#func global GetRegionData "GetRegionData" sptr, sptr, sptr
; GetRegionData hrgn, nCount, varptr(lpRgnData)   ; 戻り値は stat
; hrgn : HRGN -> "sptr"
; nCount : DWORD -> "sptr"
; lpRgnData : RGNDATA* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global GetRegionData "GetRegionData" sptr, int, var
; res = GetRegionData(hrgn, nCount, lpRgnData)
; hrgn : HRGN -> "sptr"
; nCount : DWORD -> "int"
; lpRgnData : RGNDATA* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global GetRegionData "GetRegionData" sptr, int, sptr
; res = GetRegionData(hrgn, nCount, varptr(lpRgnData))
; hrgn : HRGN -> "sptr"
; nCount : DWORD -> "int"
; lpRgnData : RGNDATA* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。