ホーム › UI.WindowsAndMessaging › DestroyCaret
DestroyCaret
関数現在のキャレットを破棄する。
シグネチャ
// USER32.dll
#include <windows.h>
BOOL DestroyCaret(void);パラメーターなし。戻り値: BOOL
公式ドキュメント
キャレットの現在の形状を破棄し、ウィンドウからキャレットを解放して、画面からキャレットを削除します。
戻り値
解説(Remarks)
DestroyCaret は、現在のタスク内のウィンドウがキャレットを所有している場合にのみキャレットを破棄します。現在のタスクに属していないウィンドウがキャレットを所有している場合、DestroyCaret は何も行わず、FALSE を返します。
システムはキューごとに 1 つのキャレットを提供します。ウィンドウは、キーボードフォーカスを持っているとき、またはアクティブなときにのみキャレットを作成する必要があります。ウィンドウは、キーボードフォーカスを失う前、または非アクティブになる前にキャレットを破棄する必要があります。
例については、Destroying a Caret を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll
#include <windows.h>
BOOL DestroyCaret(void);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool DestroyCaret();<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DestroyCaret() As <MarshalAs(UnmanagedType.Bool)> Boolean
End FunctionDeclare PtrSafe Function DestroyCaret Lib "user32" () As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
DestroyCaret = ctypes.windll.user32.DestroyCaret
DestroyCaret.restype = wintypes.BOOL
DestroyCaret.argtypes = []
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('USER32.dll')
DestroyCaret = Fiddle::Function.new(
lib['DestroyCaret'],
[],
Fiddle::TYPE_INT)#[link(name = "user32")]
extern "system" {
fn DestroyCaret() -> 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 DestroyCaret();
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DestroyCaret' -Namespace Win32 -PassThru
# $api::DestroyCaret()#uselib "USER32.dll"
#func global DestroyCaret "DestroyCaret"
; DestroyCaret ; 戻り値は stat
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global DestroyCaret "DestroyCaret"
; res = DestroyCaret(); BOOL DestroyCaret()
#uselib "USER32.dll"
#cfunc global DestroyCaret "DestroyCaret"
; res = DestroyCaret()import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procDestroyCaret = user32.NewProc("DestroyCaret")
)
r1, _, err := procDestroyCaret.Call()
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction DestroyCaret: BOOL; stdcall;
external 'USER32.dll' name 'DestroyCaret';result := DllCall("USER32\DestroyCaret", "Int")●DestroyCaret() = DLL("USER32.dll", "bool DestroyCaret()")
# 呼び出し: DestroyCaret()
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "user32" fn DestroyCaret() callconv(std.os.windows.WINAPI) i32;proc DestroyCaret(): int32 {.importc: "DestroyCaret", stdcall, dynlib: "USER32.dll".}pragma(lib, "user32");
extern(Windows)
int DestroyCaret();ccall((:DestroyCaret, "USER32.dll"), stdcall, Int32,
(),
)
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t DestroyCaret(void);
]]
local user32 = ffi.load("user32")
-- user32.DestroyCaret()
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const DestroyCaret = lib.func('__stdcall', 'DestroyCaret', 'int32_t', []);
// DestroyCaret()
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
DestroyCaret: { parameters: [], result: "i32" },
});
// lib.symbols.DestroyCaret()
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t DestroyCaret(void);
C, "USER32.dll");
// $ffi->DestroyCaret();
// 構造体/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 DestroyCaret();
}@[Link("user32")]
lib LibUSER32
fun DestroyCaret = DestroyCaret() : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef DestroyCaretNative = Int32 Function();
typedef DestroyCaretDart = int Function();
final DestroyCaret = DynamicLibrary.open('USER32.dll')
.lookupFunction<DestroyCaretNative, DestroyCaretDart>('DestroyCaret');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function DestroyCaret: BOOL; stdcall;
external 'USER32.dll' name 'DestroyCaret';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "DestroyCaret"
c_DestroyCaret :: IO CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let destroycaret =
foreign "DestroyCaret"
(void @-> returning int32_t)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)
(cffi:defcfun ("DestroyCaret" destroy-caret :convention :stdcall) :int32)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $DestroyCaret = Win32::API::More->new('USER32',
'BOOL DestroyCaret()');
# my $ret = $DestroyCaret->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f CreateCaret — 指定ウィンドウに新しいキャレットを作成する。
- f HideCaret — キャレットを画面から非表示にする。
- f ShowCaret — 非表示のキャレットを再表示する。