SetRect

関数

RECT構造体に指定した座標を設定する。

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

シグネチャ

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

BOOL SetRect(
    RECT* lprc,
    INT xLeft,
    INT yTop,
    INT xRight,
    INT yBottom
);

パラメーター

名前	型	方向	説明
lprc	RECT*	out	設定する四角形を格納する RECT 構造体へのポインター。
xLeft	INT	in	四角形の左上隅の x 座標を指定します。
yTop	INT	in	四角形の左上隅の y 座標を指定します。
xRight	INT	in	四角形の右下隅の x 座標を指定します。
yBottom	INT	in	四角形の右下隅の y 座標を指定します。

戻り値の型: BOOL

公式ドキュメント

SetRect 関数は、指定された四角形の座標を設定します。これは、left、top、right、bottom の各引数を RECT 構造体の対応するメンバーに代入することと同等です。

戻り値

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

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

解説(Remarks)

アプリケーションは四角形をさまざまな目的に使用できるため、四角形を扱う関数は明示的な測定単位を使用しません。代わりに、すべての四角形の座標と寸法は、符号付きの論理値で指定されます。測定単位は、マッピングモードと四角形が使用される関数によって決まります。

例

例については、Using Rectangles を参照してください。

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

各言語での呼び出し定義

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

BOOL SetRect(
    RECT* lprc,
    INT xLeft,
    INT yTop,
    INT xRight,
    INT yBottom
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", ExactSpelling = true)]
static extern bool SetRect(
    IntPtr lprc,   // RECT* out
    int xLeft,   // INT
    int yTop,   // INT
    int xRight,   // INT
    int yBottom   // INT
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function SetRect(
    lprc As IntPtr,   ' RECT* out
    xLeft As Integer,   ' INT
    yTop As Integer,   ' INT
    xRight As Integer,   ' INT
    yBottom As Integer   ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lprc : RECT* out
' xLeft : INT
' yTop : INT
' xRight : INT
' yBottom : INT
Declare PtrSafe Function SetRect Lib "user32" ( _
    ByVal lprc As LongPtr, _
    ByVal xLeft As Long, _
    ByVal yTop As Long, _
    ByVal xRight As Long, _
    ByVal yBottom As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetRect = ctypes.windll.user32.SetRect
SetRect.restype = wintypes.BOOL
SetRect.argtypes = [
    ctypes.c_void_p,  # lprc : RECT* out
    ctypes.c_int,  # xLeft : INT
    ctypes.c_int,  # yTop : INT
    ctypes.c_int,  # xRight : INT
    ctypes.c_int,  # yBottom : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SetRect = Fiddle::Function.new(
  lib['SetRect'],
  [
    Fiddle::TYPE_VOIDP,  # lprc : RECT* out
    Fiddle::TYPE_INT,  # xLeft : INT
    Fiddle::TYPE_INT,  # yTop : INT
    Fiddle::TYPE_INT,  # xRight : INT
    Fiddle::TYPE_INT,  # yBottom : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn SetRect(
        lprc: *mut RECT,  // RECT* out
        xLeft: i32,  // INT
        yTop: i32,  // INT
        xRight: i32,  // INT
        yBottom: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll")]
public static extern bool SetRect(IntPtr lprc, int xLeft, int yTop, int xRight, int yBottom);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetRect' -Namespace Win32 -PassThru
# $api::SetRect(lprc, xLeft, yTop, xRight, yBottom)

#uselib "USER32.dll"
#func global SetRect "SetRect" sptr, sptr, sptr, sptr, sptr
; SetRect varptr(lprc), xLeft, yTop, xRight, yBottom   ; 戻り値は stat
; lprc : RECT* out -> "sptr"
; xLeft : INT -> "sptr"
; yTop : INT -> "sptr"
; xRight : INT -> "sptr"
; yBottom : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global SetRect "SetRect" var, int, int, int, int
; res = SetRect(lprc, xLeft, yTop, xRight, yBottom)
; lprc : RECT* out -> "var"
; xLeft : INT -> "int"
; yTop : INT -> "int"
; xRight : INT -> "int"
; yBottom : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global SetRect "SetRect" sptr, int, int, int, int
; res = SetRect(varptr(lprc), xLeft, yTop, xRight, yBottom)
; lprc : RECT* out -> "sptr"
; xLeft : INT -> "int"
; yTop : INT -> "int"
; xRight : INT -> "int"
; yBottom : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。