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

HideCaret

関数
キャレットを画面から非表示にする。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL HideCaret(
    HWND hWnd   // optional
);

パラメーター

名前方向説明
hWndHWNDinoptionalキャレットを所有するウィンドウへのハンドル。このパラメーターが NULL の場合、HideCaret は現在のタスクからキャレットを所有するウィンドウを検索します。

戻り値の型: BOOL

公式ドキュメント

キャレットを画面から削除します。キャレットを非表示にしても、その現在の形状が破棄されたり、挿入位置が無効になったりすることはありません。

戻り値

Type: BOOL

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

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

解説(Remarks)

HideCaret は、指定したウィンドウがキャレットを所有している場合にのみキャレットを非表示にします。指定したウィンドウがキャレットを所有していない場合、HideCaret は何も行わず、FALSE を返します。

非表示の処理は累積されます。アプリケーションが HideCaret を連続して 5 回呼び出した場合、キャレットを表示するには ShowCaret も 5 回呼び出す必要があります。

例については、キャレットの非表示を参照してください。

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

各言語での呼び出し定義

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

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

HideCaret = ctypes.windll.user32.HideCaret
HideCaret.restype = wintypes.BOOL
HideCaret.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procHideCaret = user32.NewProc("HideCaret")
)

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

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

typedef HideCaretNative = Int32 Function(Pointer<Void>);
typedef HideCaretDart = int Function(Pointer<Void>);
final HideCaret = DynamicLibrary.open('USER32.dll')
    .lookupFunction<HideCaretNative, HideCaretDart>('HideCaret');
// hWnd : HWND optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HideCaret(
  hWnd: THandle   // HWND optional
): BOOL; stdcall;
  external 'USER32.dll' name 'HideCaret';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HideCaret"
  c_HideCaret :: Ptr () -> IO CInt
-- hWnd : HWND optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("HideCaret" hide-caret :convention :stdcall) :int32
  (h-wnd :pointer))   ; HWND optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HideCaret = Win32::API::More->new('USER32',
    'BOOL HideCaret(HANDLE hWnd)');
# my $ret = $HideCaret->Call($hWnd);
# hWnd : HWND optional -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目