ScreenToClient

関数

スクリーン座標をクライアント座標に変換する。

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

シグネチャ

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

BOOL ScreenToClient(
    HWND hWnd,
    POINT* lpPoint
);

パラメーター

名前	型	方向	説明
hWnd	HWND	in	変換に使用するクライアント領域を持つウィンドウへのハンドル。
lpPoint	POINT*	inout	変換するスクリーン座標を指定する POINT 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

ScreenToClient 関数は、画面上の指定した点のスクリーン座標をクライアント領域座標に変換します。

戻り値

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

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

解説(Remarks)

この関数は、hWnd パラメーターで識別されるウィンドウと、POINT 構造体で指定されたスクリーン座標を使用してクライアント座標を計算します。その後、スクリーン座標をクライアント座標で置き換えます。新しい座標は、指定したウィンドウのクライアント領域の左上隅を基準とします。

ScreenToClient 関数は、指定した点がスクリーン座標であることを前提とします。

すべての座標はデバイス単位で表されます。

ミラーリング状況、つまり左から右へのレイアウトから右から左へのレイアウトに変更する場合は、ScreenToClient を使用しないでください。代わりに MapWindowPoints を使用してください。詳細については、Window Features の「Window Layout and Mirroring」を参照してください。

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

各言語での呼び出し定義

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

BOOL ScreenToClient(
    HWND hWnd,
    POINT* lpPoint
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", ExactSpelling = true)]
static extern bool ScreenToClient(
    IntPtr hWnd,   // HWND
    IntPtr lpPoint   // POINT* in/out
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function ScreenToClient(
    hWnd As IntPtr,   ' HWND
    lpPoint As IntPtr   ' POINT* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hWnd : HWND
' lpPoint : POINT* in/out
Declare PtrSafe Function ScreenToClient Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal lpPoint As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ScreenToClient = ctypes.windll.user32.ScreenToClient
ScreenToClient.restype = wintypes.BOOL
ScreenToClient.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    ctypes.c_void_p,  # lpPoint : POINT* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
ScreenToClient = Fiddle::Function.new(
  lib['ScreenToClient'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # lpPoint : POINT* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn ScreenToClient(
        hWnd: *mut core::ffi::c_void,  // HWND
        lpPoint: *mut POINT  // POINT* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

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

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

出力引数:

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