PtInRect

関数

指定した点が矩形内に含まれるかどうかを判定する。

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

シグネチャ

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

BOOL PtInRect(
    const RECT* lprc,
    POINT pt
);

パラメーター

名前	型	方向	説明
lprc	RECT*	in	指定した矩形を含む RECT 構造体へのポインターです。
pt	POINT	in	指定した点を含む POINT 構造体です。

戻り値の型: BOOL

公式ドキュメント

PtInRect 関数は、指定した点が指定した矩形の内側にあるかどうかを判定します。

戻り値

指定した点が矩形の内側にある場合、戻り値は 0 以外の値になります。

指定した点が矩形の内側にない場合、戻り値は 0 になります。

解説(Remarks)

PtInRect を呼び出す前に、矩形は正規化されている必要があります。すなわち、lprc.right は lprc.left より大きく、lprc.bottom は lprc.top より大きくなければなりません。矩形が正規化されていない場合、点が矩形の内側にあると判定されることはありません。

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

例

例については、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 PtInRect(
    const RECT* lprc,
    POINT pt
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", ExactSpelling = true)]
static extern bool PtInRect(
    IntPtr lprc,   // RECT*
    POINT pt   // POINT
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function PtInRect(
    lprc As IntPtr,   ' RECT*
    pt As POINT   ' POINT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lprc : RECT*
' pt : POINT
Declare PtrSafe Function PtInRect Lib "user32" ( _
    ByVal lprc As LongPtr, _
    ByVal pt As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PtInRect = ctypes.windll.user32.PtInRect
PtInRect.restype = wintypes.BOOL
PtInRect.argtypes = [
    ctypes.c_void_p,  # lprc : RECT*
    POINT,  # pt : POINT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
PtInRect = Fiddle::Function.new(
  lib['PtInRect'],
  [
    Fiddle::TYPE_VOIDP,  # lprc : RECT*
    Fiddle::TYPE_VOIDP,  # pt : POINT
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn PtInRect(
        lprc: *const RECT,  // RECT*
        pt: POINT  // POINT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll")]
public static extern bool PtInRect(IntPtr lprc, POINT pt);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_PtInRect' -Namespace Win32 -PassThru
# $api::PtInRect(lprc, pt)

#uselib "USER32.dll"
#func global PtInRect "PtInRect" sptr, sptr
; PtInRect varptr(lprc), pt   ; 戻り値は stat
; lprc : RECT* -> "sptr"
; pt : POINT -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global PtInRect "PtInRect" var, int
; res = PtInRect(lprc, pt)
; lprc : RECT* -> "var"
; pt : POINT -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global PtInRect "PtInRect" sptr, int
; res = PtInRect(varptr(lprc), pt)
; lprc : RECT* -> "sptr"
; pt : POINT -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。