MapWindowPoints

関数

ある座標系から別のウィンドウの座標系へ複数の点を変換する。

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

シグネチャ

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

INT MapWindowPoints(
    HWND hWndFrom,   // optional
    HWND hWndTo,   // optional
    POINT* lpPoints,
    DWORD cPoints
);

パラメーター

名前	型	方向	説明
hWndFrom	HWND	inoptional	変換元となるウィンドウのハンドル。このパラメーターが NULL または HWND_DESKTOP の場合、点はスクリーン座標であるとみなされます。
hWndTo	HWND	inoptional	変換先となるウィンドウのハンドル。このパラメーターが NULL または HWND_DESKTOP の場合、点はスクリーン座標に変換されます。
lpPoints	POINT*	inout	変換対象となる点の集合を格納した POINT 構造体の配列へのポインター。点はデバイス単位で表されます。このパラメーターは RECT 構造体を指すこともでき、その場合は cPoints パラメーターを 2 に設定する必要があります。
cPoints	DWORD	in	lpPoints パラメーターが指す配列内の POINT 構造体の数。

戻り値の型: INT

公式ドキュメント

MapWindowPoints 関数は、あるウィンドウを基準とする座標空間から別のウィンドウを基準とする座標空間へ、点の集合を変換(マッピング)します。

戻り値

関数が成功した場合、戻り値の下位ワードは、各変換元の点の水平座標から各変換先の点の水平座標を計算するために加算されたピクセル数です。(これに加えて、hWndFrom と hWndTo のうちちょうど一方がミラーリングされている場合は、結果として得られる各水平座標に -1 が乗算されます。)上位ワードは、各変換元の点の垂直座標から各変換先の点の垂直座標を計算するために加算されたピクセル数です。

関数が失敗した場合、戻り値は 0 です。エラーによる戻り値と正当な「0」という戻り値を区別するには、このメソッドを呼び出す前に SetLastError を呼び出してください。

解説(Remarks)

hWndFrom または hWndTo(あるいはその両方)がミラーリングされたウィンドウ(すなわち WS_EX_LAYOUTRTL 拡張スタイルを持つウィンドウ)であり、lpPoints にちょうど 2 つの点が渡された場合、MapWindowPoints はそれらの 2 つの点を RECT として解釈し、left が right より大きくならないように、その四角形の left フィールドと right フィールドを自動的に入れ替えることがあります。lpPoints に 2 以外の数の点が渡された場合、MapWindowPoints はそれらの各点の座標を個別に正しくマッピングします。したがって、lpPoints に複数の四角形からなる配列へのポインターを渡すと、新しい四角形では left フィールドが right より大きくなる可能性があります。よって、四角形の座標を確実に正しく変換するには、次の例に示すように、一度に 1 つの RECT ポインターを指定して MapWindowPoints を呼び出す必要があります。


   RECT        rc[10];

   for(int i = 0; i < (sizeof(rc)/sizeof(rc[0])); i++)
   {
       MapWindowPoints(hWnd1, hWnd2, (LPPOINT)(&rc[i]), (sizeof(RECT)/sizeof(POINT)) );
   }

また、ちょうど 2 つの独立した点をマッピングする必要があり、MapWindowPoints によって RECT のロジックが適用されることを避けたい場合は、正しい結果を保証するために、次の例に示すように、一度に 1 つの POINT ポインターを指定して MapWindowPoints を呼び出す必要があります。


   POINT pt[2];

   MapWindowPoints(hWnd1, hWnd2, &pt[0], 1);
   MapWindowPoints(hWnd1, hWnd2, &pt[1], 1);

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

各言語での呼び出し定義

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

INT MapWindowPoints(
    HWND hWndFrom,   // optional
    HWND hWndTo,   // optional
    POINT* lpPoints,
    DWORD cPoints
);

[DllImport("USER32.dll", ExactSpelling = true)]
static extern int MapWindowPoints(
    IntPtr hWndFrom,   // HWND optional
    IntPtr hWndTo,   // HWND optional
    IntPtr lpPoints,   // POINT* in/out
    uint cPoints   // DWORD
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function MapWindowPoints(
    hWndFrom As IntPtr,   ' HWND optional
    hWndTo As IntPtr,   ' HWND optional
    lpPoints As IntPtr,   ' POINT* in/out
    cPoints As UInteger   ' DWORD
) As Integer
End Function

' hWndFrom : HWND optional
' hWndTo : HWND optional
' lpPoints : POINT* in/out
' cPoints : DWORD
Declare PtrSafe Function MapWindowPoints Lib "user32" ( _
    ByVal hWndFrom As LongPtr, _
    ByVal hWndTo As LongPtr, _
    ByVal lpPoints As LongPtr, _
    ByVal cPoints As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MapWindowPoints = ctypes.windll.user32.MapWindowPoints
MapWindowPoints.restype = ctypes.c_int
MapWindowPoints.argtypes = [
    wintypes.HANDLE,  # hWndFrom : HWND optional
    wintypes.HANDLE,  # hWndTo : HWND optional
    ctypes.c_void_p,  # lpPoints : POINT* in/out
    wintypes.DWORD,  # cPoints : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
MapWindowPoints = Fiddle::Function.new(
  lib['MapWindowPoints'],
  [
    Fiddle::TYPE_VOIDP,  # hWndFrom : HWND optional
    Fiddle::TYPE_VOIDP,  # hWndTo : HWND optional
    Fiddle::TYPE_VOIDP,  # lpPoints : POINT* in/out
    -Fiddle::TYPE_INT,  # cPoints : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn MapWindowPoints(
        hWndFrom: *mut core::ffi::c_void,  // HWND optional
        hWndTo: *mut core::ffi::c_void,  // HWND optional
        lpPoints: *mut POINT,  // POINT* in/out
        cPoints: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll")]
public static extern int MapWindowPoints(IntPtr hWndFrom, IntPtr hWndTo, IntPtr lpPoints, uint cPoints);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_MapWindowPoints' -Namespace Win32 -PassThru
# $api::MapWindowPoints(hWndFrom, hWndTo, lpPoints, cPoints)

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

出力引数:

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