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

SetCaretBlinkTime

関数
キャレットの点滅間隔の時間を設定する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetCaretBlinkTime(
    DWORD uMSeconds
);

パラメーター

名前方向説明
uMSecondsDWORDin新しい点滅時間(ミリ秒単位)。

戻り値の型: BOOL

公式ドキュメント

キャレットの点滅時間を、指定したミリ秒数に設定します。点滅時間とは、キャレットのピクセルを反転させるのに要する経過時間(ミリ秒単位)です。

戻り値

型: BOOL

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

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

解説(Remarks)

ユーザーはコントロール パネルを使用して点滅時間を設定できます。アプリケーションは、ユーザーが選択した設定を尊重する必要があります。SetCaretBlinkTime 関数は、コントロール パネル アプレットなど、ユーザーが点滅時間を設定できるアプリケーションでのみ使用してください。

点滅時間を変更すると、その後にアクティブ化されるアプリケーションは変更後の点滅時間を使用します。これは、キーボード フォーカスを失ったときや非アクティブになったときに以前の点滅時間を復元した場合でも同様です。これは、アプリケーションの非アクティブ化が別のアプリケーションのアクティブ化と同期されないマルチスレッド環境に起因します。この仕組みにより、現在のアプリケーションが応答していない場合でも、システムは別のアプリケーションをアクティブ化できます。

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

各言語での呼び出し定義

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

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

SetCaretBlinkTime = ctypes.windll.user32.SetCaretBlinkTime
SetCaretBlinkTime.restype = wintypes.BOOL
SetCaretBlinkTime.argtypes = [
    wintypes.DWORD,  # uMSeconds : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetCaretBlinkTime = user32.NewProc("SetCaretBlinkTime")
)

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

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

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

foreign import stdcall safe "SetCaretBlinkTime"
  c_SetCaretBlinkTime :: Word32 -> IO CInt
-- uMSeconds : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

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

関連項目

公式の関連項目