OffsetRect

関数

矩形を指定量だけ平行移動する。

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

シグネチャ

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

BOOL OffsetRect(
    RECT* lprc,
    INT dx,
    INT dy
);

パラメーター

名前	型	方向	説明
lprc	RECT*	inout	移動する矩形の論理座標を格納する RECT 構造体へのポインターです。
dx	INT	in	矩形を左または右に移動する量を指定します。矩形を左へ移動するには、このパラメーターを負の値にする必要があります。
dy	INT	in	矩形を上または下に移動する量を指定します。矩形を上へ移動するには、このパラメーターを負の値にする必要があります。

戻り値の型: BOOL

公式ドキュメント

OffsetRect 関数は、指定した矩形を指定したオフセットだけ移動します。

戻り値

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

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

解説(Remarks)

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

Examples

例については、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 OffsetRect(
    RECT* lprc,
    INT dx,
    INT dy
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", ExactSpelling = true)]
static extern bool OffsetRect(
    IntPtr lprc,   // RECT* in/out
    int dx,   // INT
    int dy   // INT
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function OffsetRect(
    lprc As IntPtr,   ' RECT* in/out
    dx As Integer,   ' INT
    dy As Integer   ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

OffsetRect = ctypes.windll.user32.OffsetRect
OffsetRect.restype = wintypes.BOOL
OffsetRect.argtypes = [
    ctypes.c_void_p,  # lprc : RECT* in/out
    ctypes.c_int,  # dx : INT
    ctypes.c_int,  # dy : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
OffsetRect = Fiddle::Function.new(
  lib['OffsetRect'],
  [
    Fiddle::TYPE_VOIDP,  # lprc : RECT* in/out
    Fiddle::TYPE_INT,  # dx : INT
    Fiddle::TYPE_INT,  # dy : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn OffsetRect(
        lprc: *mut RECT,  // RECT* in/out
        dx: i32,  // INT
        dy: 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 OffsetRect(IntPtr lprc, int dx, int dy);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_OffsetRect' -Namespace Win32 -PassThru
# $api::OffsetRect(lprc, dx, dy)

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

出力引数:

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