Win32 API 日本語リファレンス
ホームGraphics.Gdi › SetRectRgn

SetRectRgn

関数
既存のリージョンを指定した矩形リージョンに設定する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL SetRectRgn(
    HRGN hrgn,
    INT left,
    INT top,
    INT right,
    INT bottom
);

パラメーター

名前方向説明
hrgnHRGNinリージョンへのハンドルです。
leftINTin矩形リージョンの左上隅の x 座標を論理単位で指定します。
topINTin矩形リージョンの左上隅の y 座標を論理単位で指定します。
rightINTin矩形リージョンの右下隅の x 座標を論理単位で指定します。
bottomINTin矩形リージョンの右下隅の y 座標を論理単位で指定します。

戻り値の型: BOOL

公式ドキュメント

SetRectRgn 関数は、リージョンを指定された座標を持つ矩形リージョンに変換します。

戻り値

関数が成功すると、戻り値は 0 以外の値になります。

関数が失敗すると、戻り値は 0 になります。

解説(Remarks)

このリージョンには、矩形の下端および右端の境界は含まれません。

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

各言語での呼び出し定義

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

BOOL SetRectRgn(
    HRGN hrgn,
    INT left,
    INT top,
    INT right,
    INT bottom
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool SetRectRgn(
    IntPtr hrgn,   // HRGN
    int left,   // INT
    int top,   // INT
    int right,   // INT
    int bottom   // INT
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function SetRectRgn(
    hrgn As IntPtr,   ' HRGN
    left As Integer,   ' INT
    top As Integer,   ' INT
    right As Integer,   ' INT
    bottom As Integer   ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hrgn : HRGN
' left : INT
' top : INT
' right : INT
' bottom : INT
Declare PtrSafe Function SetRectRgn Lib "gdi32" ( _
    ByVal hrgn As LongPtr, _
    ByVal left As Long, _
    ByVal top As Long, _
    ByVal right As Long, _
    ByVal bottom As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetRectRgn = ctypes.windll.gdi32.SetRectRgn
SetRectRgn.restype = wintypes.BOOL
SetRectRgn.argtypes = [
    wintypes.HANDLE,  # hrgn : HRGN
    ctypes.c_int,  # left : INT
    ctypes.c_int,  # top : INT
    ctypes.c_int,  # right : INT
    ctypes.c_int,  # bottom : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
SetRectRgn = Fiddle::Function.new(
  lib['SetRectRgn'],
  [
    Fiddle::TYPE_VOIDP,  # hrgn : HRGN
    Fiddle::TYPE_INT,  # left : INT
    Fiddle::TYPE_INT,  # top : INT
    Fiddle::TYPE_INT,  # right : INT
    Fiddle::TYPE_INT,  # bottom : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn SetRectRgn(
        hrgn: *mut core::ffi::c_void,  // HRGN
        left: i32,  // INT
        top: i32,  // INT
        right: i32,  // INT
        bottom: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool SetRectRgn(IntPtr hrgn, int left, int top, int right, int bottom);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_SetRectRgn' -Namespace Win32 -PassThru
# $api::SetRectRgn(hrgn, left, top, right, bottom)
#uselib "GDI32.dll"
#func global SetRectRgn "SetRectRgn" sptr, sptr, sptr, sptr, sptr
; SetRectRgn hrgn, left, top, right, bottom   ; 戻り値は stat
; hrgn : HRGN -> "sptr"
; left : INT -> "sptr"
; top : INT -> "sptr"
; right : INT -> "sptr"
; bottom : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "GDI32.dll"
#cfunc global SetRectRgn "SetRectRgn" sptr, int, int, int, int
; res = SetRectRgn(hrgn, left, top, right, bottom)
; hrgn : HRGN -> "sptr"
; left : INT -> "int"
; top : INT -> "int"
; right : INT -> "int"
; bottom : INT -> "int"
; BOOL SetRectRgn(HRGN hrgn, INT left, INT top, INT right, INT bottom)
#uselib "GDI32.dll"
#cfunc global SetRectRgn "SetRectRgn" intptr, int, int, int, int
; res = SetRectRgn(hrgn, left, top, right, bottom)
; hrgn : HRGN -> "intptr"
; left : INT -> "int"
; top : INT -> "int"
; right : INT -> "int"
; bottom : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procSetRectRgn = gdi32.NewProc("SetRectRgn")
)

// hrgn (HRGN), left (INT), top (INT), right (INT), bottom (INT)
r1, _, err := procSetRectRgn.Call(
	uintptr(hrgn),
	uintptr(left),
	uintptr(top),
	uintptr(right),
	uintptr(bottom),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetRectRgn(
  hrgn: THandle;   // HRGN
  left: Integer;   // INT
  top: Integer;   // INT
  right: Integer;   // INT
  bottom: Integer   // INT
): BOOL; stdcall;
  external 'GDI32.dll' name 'SetRectRgn';
result := DllCall("GDI32\SetRectRgn"
    , "Ptr", hrgn   ; HRGN
    , "Int", left   ; INT
    , "Int", top   ; INT
    , "Int", right   ; INT
    , "Int", bottom   ; INT
    , "Int")   ; return: BOOL
●SetRectRgn(hrgn, left, top, right, bottom) = DLL("GDI32.dll", "bool SetRectRgn(void*, int, int, int, int)")
# 呼び出し: SetRectRgn(hrgn, left, top, right, bottom)
# hrgn : HRGN -> "void*"
# left : INT -> "int"
# top : INT -> "int"
# right : INT -> "int"
# bottom : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "gdi32" fn SetRectRgn(
    hrgn: ?*anyopaque, // HRGN
    left: i32, // INT
    top: i32, // INT
    right: i32, // INT
    bottom: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
proc SetRectRgn(
    hrgn: pointer,  # HRGN
    left: int32,  # INT
    top: int32,  # INT
    right: int32,  # INT
    bottom: int32  # INT
): int32 {.importc: "SetRectRgn", stdcall, dynlib: "GDI32.dll".}
pragma(lib, "gdi32");
extern(Windows)
int SetRectRgn(
    void* hrgn,   // HRGN
    int left,   // INT
    int top,   // INT
    int right,   // INT
    int bottom   // INT
);
ccall((:SetRectRgn, "GDI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32, Int32, Int32, Int32),
      hrgn, left, top, right, bottom)
# hrgn : HRGN -> Ptr{Cvoid}
# left : INT -> Int32
# top : INT -> Int32
# right : INT -> Int32
# bottom : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetRectRgn(
    void* hrgn,
    int32_t left,
    int32_t top,
    int32_t right,
    int32_t bottom);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.SetRectRgn(hrgn, left, top, right, bottom)
-- hrgn : HRGN
-- left : INT
-- top : INT
-- right : INT
-- bottom : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const SetRectRgn = lib.func('__stdcall', 'SetRectRgn', 'int32_t', ['void *', 'int32_t', 'int32_t', 'int32_t', 'int32_t']);
// SetRectRgn(hrgn, left, top, right, bottom)
// hrgn : HRGN -> 'void *'
// left : INT -> 'int32_t'
// top : INT -> 'int32_t'
// right : INT -> 'int32_t'
// bottom : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  SetRectRgn: { parameters: ["pointer", "i32", "i32", "i32", "i32"], result: "i32" },
});
// lib.symbols.SetRectRgn(hrgn, left, top, right, bottom)
// hrgn : HRGN -> "pointer"
// left : INT -> "i32"
// top : INT -> "i32"
// right : INT -> "i32"
// bottom : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetRectRgn(
    void* hrgn,
    int32_t left,
    int32_t top,
    int32_t right,
    int32_t bottom);
C, "GDI32.dll");
// $ffi->SetRectRgn(hrgn, left, top, right, bottom);
// hrgn : HRGN
// left : INT
// top : INT
// right : INT
// bottom : INT
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Gdi32 extends StdCallLibrary {
    Gdi32 INSTANCE = Native.load("gdi32", Gdi32.class);
    boolean SetRectRgn(
        Pointer hrgn,   // HRGN
        int left,   // INT
        int top,   // INT
        int right,   // INT
        int bottom   // INT
    );
}
@[Link("gdi32")]
lib LibGDI32
  fun SetRectRgn = SetRectRgn(
    hrgn : Void*,   # HRGN
    left : Int32,   # INT
    top : Int32,   # INT
    right : Int32,   # INT
    bottom : Int32   # INT
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetRectRgnNative = Int32 Function(Pointer<Void>, Int32, Int32, Int32, Int32);
typedef SetRectRgnDart = int Function(Pointer<Void>, int, int, int, int);
final SetRectRgn = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<SetRectRgnNative, SetRectRgnDart>('SetRectRgn');
// hrgn : HRGN -> Pointer<Void>
// left : INT -> Int32
// top : INT -> Int32
// right : INT -> Int32
// bottom : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetRectRgn(
  hrgn: THandle;   // HRGN
  left: Integer;   // INT
  top: Integer;   // INT
  right: Integer;   // INT
  bottom: Integer   // INT
): BOOL; stdcall;
  external 'GDI32.dll' name 'SetRectRgn';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetRectRgn"
  c_SetRectRgn :: Ptr () -> Int32 -> Int32 -> Int32 -> Int32 -> IO CInt
-- hrgn : HRGN -> Ptr ()
-- left : INT -> Int32
-- top : INT -> Int32
-- right : INT -> Int32
-- bottom : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setrectrgn =
  foreign "SetRectRgn"
    ((ptr void) @-> int32_t @-> int32_t @-> int32_t @-> int32_t @-> returning int32_t)
(* hrgn : HRGN -> (ptr void) *)
(* left : INT -> int32_t *)
(* top : INT -> int32_t *)
(* right : INT -> int32_t *)
(* bottom : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("SetRectRgn" set-rect-rgn :convention :stdcall) :int32
  (hrgn :pointer)   ; HRGN
  (left :int32)   ; INT
  (top :int32)   ; INT
  (right :int32)   ; INT
  (bottom :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetRectRgn = Win32::API::More->new('GDI32',
    'BOOL SetRectRgn(HANDLE hrgn, int left, int top, int right, int bottom)');
# my $ret = $SetRectRgn->Call($hrgn, $left, $top, $right, $bottom);
# hrgn : HRGN -> HANDLE
# left : INT -> int
# top : INT -> int
# right : INT -> int
# bottom : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目