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

CreateTimerQueueTimer

関数
タイマーキューにタイマーを作成する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CreateTimerQueueTimer(
    HANDLE* phNewTimer,
    HANDLE TimerQueue,   // optional
    WAITORTIMERCALLBACK Callback,
    void* Parameter,   // optional
    DWORD DueTime,
    DWORD Period,
    WORKER_THREAD_FLAGS Flags
);

パラメーター

名前方向
phNewTimerHANDLE*out
TimerQueueHANDLEinoptional
CallbackWAITORTIMERCALLBACKin
Parametervoid*inoptional
DueTimeDWORDin
PeriodDWORDin
FlagsWORKER_THREAD_FLAGSin

戻り値の型: BOOL

各言語での呼び出し定義

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

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

CreateTimerQueueTimer = ctypes.windll.kernel32.CreateTimerQueueTimer
CreateTimerQueueTimer.restype = wintypes.BOOL
CreateTimerQueueTimer.argtypes = [
    ctypes.c_void_p,  # phNewTimer : HANDLE* out
    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.DWORD,  # Flags : WORKER_THREAD_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateTimerQueueTimer = kernel32.NewProc("CreateTimerQueueTimer")
)

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