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

FrameRgn

関数
指定ブラシで領域の枠線を描画する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL FrameRgn(
    HDC hdc,
    HRGN hrgn,
    HBRUSH hbr,
    INT w,
    INT h
);

パラメーター

名前方向説明
hdcHDCinデバイスコンテキストのハンドル。
hrgnHRGNin境界線で囲むリージョンのハンドル。リージョンの座標は論理単位であると見なされます。
hbrHBRUSHin境界線の描画に使用するブラシのハンドル。
wINTin垂直方向のブラシストロークの幅を論理単位で指定します。
hINTin水平方向のブラシストロークの高さを論理単位で指定します。

戻り値の型: BOOL

公式ドキュメント

FrameRgn 関数は、指定したブラシを使用して、指定したリージョンの周囲に境界線を描画します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

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

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

各言語での呼び出し定義

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

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

FrameRgn = ctypes.windll.gdi32.FrameRgn
FrameRgn.restype = wintypes.BOOL
FrameRgn.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    wintypes.HANDLE,  # hrgn : HRGN
    wintypes.HANDLE,  # hbr : HBRUSH
    ctypes.c_int,  # w : INT
    ctypes.c_int,  # h : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
FrameRgn = Fiddle::Function.new(
  lib['FrameRgn'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # hrgn : HRGN
    Fiddle::TYPE_VOIDP,  # hbr : HBRUSH
    Fiddle::TYPE_INT,  # w : INT
    Fiddle::TYPE_INT,  # h : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn FrameRgn(
        hdc: *mut core::ffi::c_void,  // HDC
        hrgn: *mut core::ffi::c_void,  // HRGN
        hbr: *mut core::ffi::c_void,  // HBRUSH
        w: i32,  // INT
        h: 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 FrameRgn(IntPtr hdc, IntPtr hrgn, IntPtr hbr, int w, int h);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_FrameRgn' -Namespace Win32 -PassThru
# $api::FrameRgn(hdc, hrgn, hbr, w, h)
#uselib "GDI32.dll"
#func global FrameRgn "FrameRgn" sptr, sptr, sptr, sptr, sptr
; FrameRgn hdc, hrgn, hbr, w, h   ; 戻り値は stat
; hdc : HDC -> "sptr"
; hrgn : HRGN -> "sptr"
; hbr : HBRUSH -> "sptr"
; w : INT -> "sptr"
; h : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "GDI32.dll"
#cfunc global FrameRgn "FrameRgn" sptr, sptr, sptr, int, int
; res = FrameRgn(hdc, hrgn, hbr, w, h)
; hdc : HDC -> "sptr"
; hrgn : HRGN -> "sptr"
; hbr : HBRUSH -> "sptr"
; w : INT -> "int"
; h : INT -> "int"
; BOOL FrameRgn(HDC hdc, HRGN hrgn, HBRUSH hbr, INT w, INT h)
#uselib "GDI32.dll"
#cfunc global FrameRgn "FrameRgn" intptr, intptr, intptr, int, int
; res = FrameRgn(hdc, hrgn, hbr, w, h)
; hdc : HDC -> "intptr"
; hrgn : HRGN -> "intptr"
; hbr : HBRUSH -> "intptr"
; w : INT -> "int"
; h : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procFrameRgn = gdi32.NewProc("FrameRgn")
)

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

extern "gdi32" fn FrameRgn(
    hdc: ?*anyopaque, // HDC
    hrgn: ?*anyopaque, // HRGN
    hbr: ?*anyopaque, // HBRUSH
    w: i32, // INT
    h: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
proc FrameRgn(
    hdc: pointer,  # HDC
    hrgn: pointer,  # HRGN
    hbr: pointer,  # HBRUSH
    w: int32,  # INT
    h: int32  # INT
): int32 {.importc: "FrameRgn", stdcall, dynlib: "GDI32.dll".}
pragma(lib, "gdi32");
extern(Windows)
int FrameRgn(
    void* hdc,   // HDC
    void* hrgn,   // HRGN
    void* hbr,   // HBRUSH
    int w,   // INT
    int h   // INT
);
ccall((:FrameRgn, "GDI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}, Int32, Int32),
      hdc, hrgn, hbr, w, h)
# hdc : HDC -> Ptr{Cvoid}
# hrgn : HRGN -> Ptr{Cvoid}
# hbr : HBRUSH -> Ptr{Cvoid}
# w : INT -> Int32
# h : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FrameRgn(
    void* hdc,
    void* hrgn,
    void* hbr,
    int32_t w,
    int32_t h);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.FrameRgn(hdc, hrgn, hbr, w, h)
-- hdc : HDC
-- hrgn : HRGN
-- hbr : HBRUSH
-- w : INT
-- h : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const FrameRgn = lib.func('__stdcall', 'FrameRgn', 'int32_t', ['void *', 'void *', 'void *', 'int32_t', 'int32_t']);
// FrameRgn(hdc, hrgn, hbr, w, h)
// hdc : HDC -> 'void *'
// hrgn : HRGN -> 'void *'
// hbr : HBRUSH -> 'void *'
// w : INT -> 'int32_t'
// h : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  FrameRgn: { parameters: ["pointer", "pointer", "pointer", "i32", "i32"], result: "i32" },
});
// lib.symbols.FrameRgn(hdc, hrgn, hbr, w, h)
// hdc : HDC -> "pointer"
// hrgn : HRGN -> "pointer"
// hbr : HBRUSH -> "pointer"
// w : INT -> "i32"
// h : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FrameRgn(
    void* hdc,
    void* hrgn,
    void* hbr,
    int32_t w,
    int32_t h);
C, "GDI32.dll");
// $ffi->FrameRgn(hdc, hrgn, hbr, w, h);
// hdc : HDC
// hrgn : HRGN
// hbr : HBRUSH
// w : INT
// h : 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 FrameRgn(
        Pointer hdc,   // HDC
        Pointer hrgn,   // HRGN
        Pointer hbr,   // HBRUSH
        int w,   // INT
        int h   // INT
    );
}
@[Link("gdi32")]
lib LibGDI32
  fun FrameRgn = FrameRgn(
    hdc : Void*,   # HDC
    hrgn : Void*,   # HRGN
    hbr : Void*,   # HBRUSH
    w : Int32,   # INT
    h : 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 FrameRgnNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Int32, Int32);
typedef FrameRgnDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, int, int);
final FrameRgn = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<FrameRgnNative, FrameRgnDart>('FrameRgn');
// hdc : HDC -> Pointer<Void>
// hrgn : HRGN -> Pointer<Void>
// hbr : HBRUSH -> Pointer<Void>
// w : INT -> Int32
// h : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FrameRgn(
  hdc: THandle;   // HDC
  hrgn: THandle;   // HRGN
  hbr: THandle;   // HBRUSH
  w: Integer;   // INT
  h: Integer   // INT
): BOOL; stdcall;
  external 'GDI32.dll' name 'FrameRgn';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FrameRgn"
  c_FrameRgn :: Ptr () -> Ptr () -> Ptr () -> Int32 -> Int32 -> IO CInt
-- hdc : HDC -> Ptr ()
-- hrgn : HRGN -> Ptr ()
-- hbr : HBRUSH -> Ptr ()
-- w : INT -> Int32
-- h : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let framergn =
  foreign "FrameRgn"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> int32_t @-> int32_t @-> returning int32_t)
(* hdc : HDC -> (ptr void) *)
(* hrgn : HRGN -> (ptr void) *)
(* hbr : HBRUSH -> (ptr void) *)
(* w : INT -> int32_t *)
(* h : 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 ("FrameRgn" frame-rgn :convention :stdcall) :int32
  (hdc :pointer)   ; HDC
  (hrgn :pointer)   ; HRGN
  (hbr :pointer)   ; HBRUSH
  (w :int32)   ; INT
  (h :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FrameRgn = Win32::API::More->new('GDI32',
    'BOOL FrameRgn(HANDLE hdc, HANDLE hrgn, HANDLE hbr, int w, int h)');
# my $ret = $FrameRgn->Call($hdc, $hrgn, $hbr, $w, $h);
# hdc : HDC -> HANDLE
# hrgn : HRGN -> HANDLE
# hbr : HBRUSH -> HANDLE
# w : INT -> int
# h : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目