Win32 API 日本語リファレンス
ホームSystem.Threading › SetTimerQueueTimer

SetTimerQueueTimer

関数
タイマーキューにコールバック付きタイマーを設定する。
DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

HANDLE SetTimerQueueTimer(
    HANDLE TimerQueue,   // optional
    WAITORTIMERCALLBACK Callback,
    void* Parameter,   // optional
    DWORD DueTime,
    DWORD Period,
    BOOL PreferIo
);

パラメーター

名前方向説明
TimerQueueHANDLEinoptionalタイマーを追加する対象タイマーキューのハンドル。NULLで既定キューを使う。
CallbackWAITORTIMERCALLBACKinタイマー満了時に呼ばれるコールバック関数(WAITORTIMERCALLBACK)。
Parametervoid*inoptionalコールバックへ渡される任意のパラメータへのポインタ。NULL可。
DueTimeDWORDinタイマーが最初に発火するまでの時間(ミリ秒)。
PeriodDWORDin繰り返し発火の周期(ミリ秒)。0で一度だけ発火する。
PreferIoBOOLinTRUEで永続スレッドにより I/O 完了を優先処理する旧パラメータ。

戻り値の型: HANDLE

各言語での呼び出し定義

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

HANDLE SetTimerQueueTimer(
    HANDLE TimerQueue,   // optional
    WAITORTIMERCALLBACK Callback,
    void* Parameter,   // optional
    DWORD DueTime,
    DWORD Period,
    BOOL PreferIo
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern IntPtr SetTimerQueueTimer(
    IntPtr TimerQueue,   // HANDLE optional
    IntPtr Callback,   // WAITORTIMERCALLBACK
    IntPtr Parameter,   // void* optional
    uint DueTime,   // DWORD
    uint Period,   // DWORD
    bool PreferIo   // BOOL
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function SetTimerQueueTimer(
    TimerQueue As IntPtr,   ' HANDLE optional
    Callback As IntPtr,   ' WAITORTIMERCALLBACK
    Parameter As IntPtr,   ' void* optional
    DueTime As UInteger,   ' DWORD
    Period As UInteger,   ' DWORD
    PreferIo As Boolean   ' BOOL
) As IntPtr
End Function
' TimerQueue : HANDLE optional
' Callback : WAITORTIMERCALLBACK
' Parameter : void* optional
' DueTime : DWORD
' Period : DWORD
' PreferIo : BOOL
Declare PtrSafe Function SetTimerQueueTimer Lib "kernel32" ( _
    ByVal TimerQueue As LongPtr, _
    ByVal Callback As LongPtr, _
    ByVal Parameter As LongPtr, _
    ByVal DueTime As Long, _
    ByVal Period As Long, _
    ByVal PreferIo As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetTimerQueueTimer = ctypes.windll.kernel32.SetTimerQueueTimer
SetTimerQueueTimer.restype = ctypes.c_void_p
SetTimerQueueTimer.argtypes = [
    wintypes.HANDLE,  # TimerQueue : HANDLE optional
    ctypes.c_void_p,  # Callback : WAITORTIMERCALLBACK
    ctypes.POINTER(None),  # Parameter : void* optional
    wintypes.DWORD,  # DueTime : DWORD
    wintypes.DWORD,  # Period : DWORD
    wintypes.BOOL,  # PreferIo : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetTimerQueueTimer = Fiddle::Function.new(
  lib['SetTimerQueueTimer'],
  [
    Fiddle::TYPE_VOIDP,  # TimerQueue : HANDLE optional
    Fiddle::TYPE_VOIDP,  # Callback : WAITORTIMERCALLBACK
    Fiddle::TYPE_VOIDP,  # Parameter : void* optional
    -Fiddle::TYPE_INT,  # DueTime : DWORD
    -Fiddle::TYPE_INT,  # Period : DWORD
    Fiddle::TYPE_INT,  # PreferIo : BOOL
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn SetTimerQueueTimer(
        TimerQueue: *mut core::ffi::c_void,  // HANDLE optional
        Callback: *const core::ffi::c_void,  // WAITORTIMERCALLBACK
        Parameter: *mut (),  // void* optional
        DueTime: u32,  // DWORD
        Period: u32,  // DWORD
        PreferIo: i32  // BOOL
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern IntPtr SetTimerQueueTimer(IntPtr TimerQueue, IntPtr Callback, IntPtr Parameter, uint DueTime, uint Period, bool PreferIo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetTimerQueueTimer' -Namespace Win32 -PassThru
# $api::SetTimerQueueTimer(TimerQueue, Callback, Parameter, DueTime, Period, PreferIo)
#uselib "KERNEL32.dll"
#func global SetTimerQueueTimer "SetTimerQueueTimer" sptr, sptr, sptr, sptr, sptr, sptr
; SetTimerQueueTimer TimerQueue, Callback, Parameter, DueTime, Period, PreferIo   ; 戻り値は stat
; TimerQueue : HANDLE optional -> "sptr"
; Callback : WAITORTIMERCALLBACK -> "sptr"
; Parameter : void* optional -> "sptr"
; DueTime : DWORD -> "sptr"
; Period : DWORD -> "sptr"
; PreferIo : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetTimerQueueTimer "SetTimerQueueTimer" sptr, sptr, sptr, int, int, int
; res = SetTimerQueueTimer(TimerQueue, Callback, Parameter, DueTime, Period, PreferIo)
; TimerQueue : HANDLE optional -> "sptr"
; Callback : WAITORTIMERCALLBACK -> "sptr"
; Parameter : void* optional -> "sptr"
; DueTime : DWORD -> "int"
; Period : DWORD -> "int"
; PreferIo : BOOL -> "int"
; HANDLE SetTimerQueueTimer(HANDLE TimerQueue, WAITORTIMERCALLBACK Callback, void* Parameter, DWORD DueTime, DWORD Period, BOOL PreferIo)
#uselib "KERNEL32.dll"
#cfunc global SetTimerQueueTimer "SetTimerQueueTimer" intptr, intptr, intptr, int, int, int
; res = SetTimerQueueTimer(TimerQueue, Callback, Parameter, DueTime, Period, PreferIo)
; TimerQueue : HANDLE optional -> "intptr"
; Callback : WAITORTIMERCALLBACK -> "intptr"
; Parameter : void* optional -> "intptr"
; DueTime : DWORD -> "int"
; Period : DWORD -> "int"
; PreferIo : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetTimerQueueTimer = kernel32.NewProc("SetTimerQueueTimer")
)

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

extern "kernel32" fn SetTimerQueueTimer(
    TimerQueue: ?*anyopaque, // HANDLE optional
    Callback: ?*anyopaque, // WAITORTIMERCALLBACK
    Parameter: ?*anyopaque, // void* optional
    DueTime: u32, // DWORD
    Period: u32, // DWORD
    PreferIo: i32 // BOOL
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc SetTimerQueueTimer(
    TimerQueue: pointer,  # HANDLE optional
    Callback: pointer,  # WAITORTIMERCALLBACK
    Parameter: pointer,  # void* optional
    DueTime: uint32,  # DWORD
    Period: uint32,  # DWORD
    PreferIo: int32  # BOOL
): pointer {.importc: "SetTimerQueueTimer", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
void* SetTimerQueueTimer(
    void* TimerQueue,   // HANDLE optional
    void* Callback,   // WAITORTIMERCALLBACK
    void* Parameter,   // void* optional
    uint DueTime,   // DWORD
    uint Period,   // DWORD
    int PreferIo   // BOOL
);
ccall((:SetTimerQueueTimer, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
      (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}, UInt32, UInt32, Int32),
      TimerQueue, Callback, Parameter, DueTime, Period, PreferIo)
# TimerQueue : HANDLE optional -> Ptr{Cvoid}
# Callback : WAITORTIMERCALLBACK -> Ptr{Cvoid}
# Parameter : void* optional -> Ptr{Cvoid}
# DueTime : DWORD -> UInt32
# Period : DWORD -> UInt32
# PreferIo : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* SetTimerQueueTimer(
    void* TimerQueue,
    void* Callback,
    void* Parameter,
    uint32_t DueTime,
    uint32_t Period,
    int32_t PreferIo);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetTimerQueueTimer(TimerQueue, Callback, Parameter, DueTime, Period, PreferIo)
-- TimerQueue : HANDLE optional
-- Callback : WAITORTIMERCALLBACK
-- Parameter : void* optional
-- DueTime : DWORD
-- Period : DWORD
-- PreferIo : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetTimerQueueTimer = lib.func('__stdcall', 'SetTimerQueueTimer', 'void *', ['void *', 'void *', 'void *', 'uint32_t', 'uint32_t', 'int32_t']);
// SetTimerQueueTimer(TimerQueue, Callback, Parameter, DueTime, Period, PreferIo)
// TimerQueue : HANDLE optional -> 'void *'
// Callback : WAITORTIMERCALLBACK -> 'void *'
// Parameter : void* optional -> 'void *'
// DueTime : DWORD -> 'uint32_t'
// Period : DWORD -> 'uint32_t'
// PreferIo : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetTimerQueueTimer: { parameters: ["pointer", "pointer", "pointer", "u32", "u32", "i32"], result: "pointer" },
});
// lib.symbols.SetTimerQueueTimer(TimerQueue, Callback, Parameter, DueTime, Period, PreferIo)
// TimerQueue : HANDLE optional -> "pointer"
// Callback : WAITORTIMERCALLBACK -> "pointer"
// Parameter : void* optional -> "pointer"
// DueTime : DWORD -> "u32"
// Period : DWORD -> "u32"
// PreferIo : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* SetTimerQueueTimer(
    void* TimerQueue,
    void* Callback,
    void* Parameter,
    uint32_t DueTime,
    uint32_t Period,
    int32_t PreferIo);
C, "KERNEL32.dll");
// $ffi->SetTimerQueueTimer(TimerQueue, Callback, Parameter, DueTime, Period, PreferIo);
// TimerQueue : HANDLE optional
// Callback : WAITORTIMERCALLBACK
// Parameter : void* optional
// DueTime : DWORD
// Period : DWORD
// PreferIo : BOOL
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    Pointer SetTimerQueueTimer(
        Pointer TimerQueue,   // HANDLE optional
        Callback Callback,   // WAITORTIMERCALLBACK
        Pointer Parameter,   // void* optional
        int DueTime,   // DWORD
        int Period,   // DWORD
        boolean PreferIo   // BOOL
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetTimerQueueTimer = SetTimerQueueTimer(
    TimerQueue : Void*,   # HANDLE optional
    Callback : Void*,   # WAITORTIMERCALLBACK
    Parameter : Void*,   # void* optional
    DueTime : UInt32,   # DWORD
    Period : UInt32,   # DWORD
    PreferIo : Int32   # BOOL
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetTimerQueueTimerNative = Pointer<Void> Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Uint32, Uint32, Int32);
typedef SetTimerQueueTimerDart = Pointer<Void> Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, int, int, int);
final SetTimerQueueTimer = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetTimerQueueTimerNative, SetTimerQueueTimerDart>('SetTimerQueueTimer');
// TimerQueue : HANDLE optional -> Pointer<Void>
// Callback : WAITORTIMERCALLBACK -> Pointer<Void>
// Parameter : void* optional -> Pointer<Void>
// DueTime : DWORD -> Uint32
// Period : DWORD -> Uint32
// PreferIo : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetTimerQueueTimer(
  TimerQueue: THandle;   // HANDLE optional
  Callback: Pointer;   // WAITORTIMERCALLBACK
  Parameter: Pointer;   // void* optional
  DueTime: DWORD;   // DWORD
  Period: DWORD;   // DWORD
  PreferIo: BOOL   // BOOL
): THandle; stdcall;
  external 'KERNEL32.dll' name 'SetTimerQueueTimer';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetTimerQueueTimer"
  c_SetTimerQueueTimer :: Ptr () -> Ptr () -> Ptr () -> Word32 -> Word32 -> CInt -> IO (Ptr ())
-- TimerQueue : HANDLE optional -> Ptr ()
-- Callback : WAITORTIMERCALLBACK -> Ptr ()
-- Parameter : void* optional -> Ptr ()
-- DueTime : DWORD -> Word32
-- Period : DWORD -> Word32
-- PreferIo : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let settimerqueuetimer =
  foreign "SetTimerQueueTimer"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> uint32_t @-> uint32_t @-> int32_t @-> returning (ptr void))
(* TimerQueue : HANDLE optional -> (ptr void) *)
(* Callback : WAITORTIMERCALLBACK -> (ptr void) *)
(* Parameter : void* optional -> (ptr void) *)
(* DueTime : DWORD -> uint32_t *)
(* Period : DWORD -> uint32_t *)
(* PreferIo : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetTimerQueueTimer" set-timer-queue-timer :convention :stdcall) :pointer
  (timer-queue :pointer)   ; HANDLE optional
  (callback :pointer)   ; WAITORTIMERCALLBACK
  (parameter :pointer)   ; void* optional
  (due-time :uint32)   ; DWORD
  (period :uint32)   ; DWORD
  (prefer-io :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetTimerQueueTimer = Win32::API::More->new('KERNEL32',
    'HANDLE SetTimerQueueTimer(HANDLE TimerQueue, LPVOID Callback, LPVOID Parameter, DWORD DueTime, DWORD Period, BOOL PreferIo)');
# my $ret = $SetTimerQueueTimer->Call($TimerQueue, $Callback, $Parameter, $DueTime, $Period, $PreferIo);
# TimerQueue : HANDLE optional -> HANDLE
# Callback : WAITORTIMERCALLBACK -> LPVOID
# Parameter : void* optional -> LPVOID
# DueTime : DWORD -> DWORD
# Period : DWORD -> DWORD
# PreferIo : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型