Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › GetCaretPos

GetCaretPos

関数
キャレットの現在位置を取得する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetCaretPos(
    POINT* lpPoint
);

パラメーター

名前方向説明
lpPointPOINT*outキャレットのクライアント座標を受け取る POINT 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

キャレットの位置を指定された POINT 構造体にコピーします。

戻り値

型: BOOL

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

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

キャレットの位置は、常にキャレットを含むウィンドウのクライアント座標で表されます。

DPI 仮想化

この API は DPI 仮想化に参加しません。返される値は、対象ウィンドウにおける論理サイズとして解釈されます。呼び出し元のスレッドは考慮されません。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL GetCaretPos(
    POINT* lpPoint
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetCaretPos(
    IntPtr lpPoint   // POINT* out
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetCaretPos(
    lpPoint As IntPtr   ' POINT* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpPoint : POINT* out
Declare PtrSafe Function GetCaretPos Lib "user32" ( _
    ByVal lpPoint As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetCaretPos = ctypes.windll.user32.GetCaretPos
GetCaretPos.restype = wintypes.BOOL
GetCaretPos.argtypes = [
    ctypes.c_void_p,  # lpPoint : POINT* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetCaretPos = Fiddle::Function.new(
  lib['GetCaretPos'],
  [
    Fiddle::TYPE_VOIDP,  # lpPoint : POINT* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn GetCaretPos(
        lpPoint: *mut POINT  // POINT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool GetCaretPos(IntPtr lpPoint);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetCaretPos' -Namespace Win32 -PassThru
# $api::GetCaretPos(lpPoint)
#uselib "USER32.dll"
#func global GetCaretPos "GetCaretPos" sptr
; GetCaretPos varptr(lpPoint)   ; 戻り値は stat
; lpPoint : POINT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global GetCaretPos "GetCaretPos" var
; res = GetCaretPos(lpPoint)
; lpPoint : POINT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetCaretPos(POINT* lpPoint)
#uselib "USER32.dll"
#cfunc global GetCaretPos "GetCaretPos" var
; res = GetCaretPos(lpPoint)
; lpPoint : POINT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetCaretPos = user32.NewProc("GetCaretPos")
)

// lpPoint (POINT* out)
r1, _, err := procGetCaretPos.Call(
	uintptr(lpPoint),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetCaretPos(
  lpPoint: Pointer   // POINT* out
): BOOL; stdcall;
  external 'USER32.dll' name 'GetCaretPos';
result := DllCall("USER32\GetCaretPos"
    , "Ptr", lpPoint   ; POINT* out
    , "Int")   ; return: BOOL
●GetCaretPos(lpPoint) = DLL("USER32.dll", "bool GetCaretPos(void*)")
# 呼び出し: GetCaretPos(lpPoint)
# lpPoint : POINT* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn GetCaretPos(
    lpPoint: [*c]POINT // POINT* out
) callconv(std.os.windows.WINAPI) i32;
proc GetCaretPos(
    lpPoint: ptr POINT  # POINT* out
): int32 {.importc: "GetCaretPos", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int GetCaretPos(
    POINT* lpPoint   // POINT* out
);
ccall((:GetCaretPos, "USER32.dll"), stdcall, Int32,
      (Ptr{POINT},),
      lpPoint)
# lpPoint : POINT* out -> Ptr{POINT}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetCaretPos(
    void* lpPoint);
]]
local user32 = ffi.load("user32")
-- user32.GetCaretPos(lpPoint)
-- lpPoint : POINT* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetCaretPos = lib.func('__stdcall', 'GetCaretPos', 'int32_t', ['void *']);
// GetCaretPos(lpPoint)
// lpPoint : POINT* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetCaretPos: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.GetCaretPos(lpPoint)
// lpPoint : POINT* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetCaretPos(
    void* lpPoint);
C, "USER32.dll");
// $ffi->GetCaretPos(lpPoint);
// lpPoint : POINT* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class);
    boolean GetCaretPos(
        Pointer lpPoint   // POINT* out
    );
}
@[Link("user32")]
lib LibUSER32
  fun GetCaretPos = GetCaretPos(
    lpPoint : POINT*   # POINT* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetCaretPosNative = Int32 Function(Pointer<Void>);
typedef GetCaretPosDart = int Function(Pointer<Void>);
final GetCaretPos = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetCaretPosNative, GetCaretPosDart>('GetCaretPos');
// lpPoint : POINT* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetCaretPos(
  lpPoint: Pointer   // POINT* out
): BOOL; stdcall;
  external 'USER32.dll' name 'GetCaretPos';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetCaretPos"
  c_GetCaretPos :: Ptr () -> IO CInt
-- lpPoint : POINT* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getcaretpos =
  foreign "GetCaretPos"
    ((ptr void) @-> returning int32_t)
(* lpPoint : POINT* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("GetCaretPos" get-caret-pos :convention :stdcall) :int32
  (lp-point :pointer))   ; POINT* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetCaretPos = Win32::API::More->new('USER32',
    'BOOL GetCaretPos(LPVOID lpPoint)');
# my $ret = $GetCaretPos->Call($lpPoint);
# lpPoint : POINT* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型