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

SetCaretPos

関数
キャレットを指定座標へ移動する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetCaretPos(
    INT X,
    INT Y
);

パラメーター

名前方向説明
XINTinキャレットの新しい x 座標です。
YINTinキャレットの新しい y 座標です。

戻り値の型: BOOL

公式ドキュメント

キャレットを指定された座標へ移動します。キャレットを所有するウィンドウが CS_OWNDC クラススタイルで作成されている場合、指定する座標はそのウィンドウに関連付けられたデバイスコンテキストのマッピングモードの影響を受けます。

戻り値

型: BOOL

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

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

解説(Remarks)

SetCaretPos は、キャレットが非表示であるかどうかにかかわらずキャレットを移動します。

システムはキューごとに 1 つのキャレットを提供します。ウィンドウは、キーボードフォーカスを持っているとき、またはアクティブであるときにのみキャレットを作成してください。ウィンドウは、キーボードフォーカスを失う前、または非アクティブになる前にキャレットを破棄してください。ウィンドウは、キャレットを所有している場合にのみキャレットの位置を設定できます。

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 SetCaretPos(
    INT X,
    INT Y
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetCaretPos(
    int X,   // INT
    int Y   // INT
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetCaretPos(
    X As Integer,   ' INT
    Y As Integer   ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' X : INT
' Y : INT
Declare PtrSafe Function SetCaretPos Lib "user32" ( _
    ByVal X As Long, _
    ByVal Y As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetCaretPos = ctypes.windll.user32.SetCaretPos
SetCaretPos.restype = wintypes.BOOL
SetCaretPos.argtypes = [
    ctypes.c_int,  # X : INT
    ctypes.c_int,  # Y : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SetCaretPos = Fiddle::Function.new(
  lib['SetCaretPos'],
  [
    Fiddle::TYPE_INT,  # X : INT
    Fiddle::TYPE_INT,  # Y : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn SetCaretPos(
        X: i32,  // INT
        Y: i32  // INT
    ) -> 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 SetCaretPos(int X, int Y);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetCaretPos' -Namespace Win32 -PassThru
# $api::SetCaretPos(X, Y)
#uselib "USER32.dll"
#func global SetCaretPos "SetCaretPos" sptr, sptr
; SetCaretPos X, Y   ; 戻り値は stat
; X : INT -> "sptr"
; Y : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global SetCaretPos "SetCaretPos" int, int
; res = SetCaretPos(X, Y)
; X : INT -> "int"
; Y : INT -> "int"
; BOOL SetCaretPos(INT X, INT Y)
#uselib "USER32.dll"
#cfunc global SetCaretPos "SetCaretPos" int, int
; res = SetCaretPos(X, Y)
; X : INT -> "int"
; Y : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetCaretPos = user32.NewProc("SetCaretPos")
)

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

extern "user32" fn SetCaretPos(
    X: i32, // INT
    Y: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
proc SetCaretPos(
    X: int32,  # INT
    Y: int32  # INT
): int32 {.importc: "SetCaretPos", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int SetCaretPos(
    int X,   // INT
    int Y   // INT
);
ccall((:SetCaretPos, "USER32.dll"), stdcall, Int32,
      (Int32, Int32),
      X, Y)
# X : INT -> Int32
# Y : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetCaretPos(
    int32_t X,
    int32_t Y);
]]
local user32 = ffi.load("user32")
-- user32.SetCaretPos(X, Y)
-- X : INT
-- Y : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const SetCaretPos = lib.func('__stdcall', 'SetCaretPos', 'int32_t', ['int32_t', 'int32_t']);
// SetCaretPos(X, Y)
// X : INT -> 'int32_t'
// Y : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  SetCaretPos: { parameters: ["i32", "i32"], result: "i32" },
});
// lib.symbols.SetCaretPos(X, Y)
// X : INT -> "i32"
// Y : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetCaretPos(
    int32_t X,
    int32_t Y);
C, "USER32.dll");
// $ffi->SetCaretPos(X, Y);
// X : INT
// Y : INT
// 構造体/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 SetCaretPos(
        int X,   // INT
        int Y   // INT
    );
}
@[Link("user32")]
lib LibUSER32
  fun SetCaretPos = SetCaretPos(
    X : Int32,   # INT
    Y : Int32   # INT
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetCaretPosNative = Int32 Function(Int32, Int32);
typedef SetCaretPosDart = int Function(int, int);
final SetCaretPos = DynamicLibrary.open('USER32.dll')
    .lookupFunction<SetCaretPosNative, SetCaretPosDart>('SetCaretPos');
// X : INT -> Int32
// Y : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetCaretPos(
  X: Integer;   // INT
  Y: Integer   // INT
): BOOL; stdcall;
  external 'USER32.dll' name 'SetCaretPos';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetCaretPos"
  c_SetCaretPos :: Int32 -> Int32 -> IO CInt
-- X : INT -> Int32
-- Y : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setcaretpos =
  foreign "SetCaretPos"
    (int32_t @-> int32_t @-> returning int32_t)
(* X : INT -> int32_t *)
(* Y : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("SetCaretPos" set-caret-pos :convention :stdcall) :int32
  (x :int32)   ; INT
  (y :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetCaretPos = Win32::API::More->new('USER32',
    'BOOL SetCaretPos(int X, int Y)');
# my $ret = $SetCaretPos->Call($X, $Y);
# X : INT -> int
# Y : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目