ホーム › System.Threading › ChangeTimerQueueTimer
ChangeTimerQueueTimer
関数タイマーキュータイマーの発火時刻と周期を変更する。
シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL ChangeTimerQueueTimer(
HANDLE TimerQueue, // optional
HANDLE Timer,
DWORD DueTime,
DWORD Period
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| TimerQueue | HANDLE | inoptional | タイマーキューへのハンドル。このハンドルは CreateTimerQueue 関数によって返されます。 このパラメーターが NULL の場合、タイマーは既定のタイマーキューに関連付けられます。 |
| Timer | HANDLE | inout | タイマーキュータイマーへのハンドル。このハンドルは CreateTimerQueueTimer 関数によって返されます。 |
| DueTime | DWORD | in | タイマーが期限切れになるまでの時間(ミリ秒単位)。 |
| Period | DWORD | in | タイマーの周期(ミリ秒単位)。このパラメーターが 0 の場合、タイマーは一度だけシグナル状態になります。このパラメーターが 0 より大きい場合、タイマーは周期的になります。周期的なタイマーは、 DeleteTimerQueueTimer 関数でタイマーがキャンセルされるか、 ChangeTimerQueueTimer でリセットされるまで、周期が経過するたびに自動的に再アクティブ化されます。 |
戻り値の型: BOOL
公式ドキュメント
CreateTimerQueueTimer 関数によって作成されたタイマーキュータイマーを更新します。
戻り値
関数が成功した場合、戻り値は 0 以外の値になります。
関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。
解説(Remarks)
この関数は、スレッドが偽装(impersonation)を使用している間は呼び出すことができません。呼び出した場合の動作は未定義です。
ChangeTimerQueueTimer はタイマーコールバック内で呼び出すことができます。
既に期限切れになっているワンショットタイマー(周期が 0)に対して ChangeTimerQueueTimer を呼び出した場合、タイマーは更新されません。
ハンドルに対して DeleteTimerQueueTimer を呼び出した後に、 ChangeTimerQueueTimer を呼び出さないでください。
この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0500 以降として定義します。詳細については、 Using the Windows Headers を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
BOOL ChangeTimerQueueTimer(
HANDLE TimerQueue, // optional
HANDLE Timer,
DWORD DueTime,
DWORD Period
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ChangeTimerQueueTimer(
IntPtr TimerQueue, // HANDLE optional
IntPtr Timer, // HANDLE in/out
uint DueTime, // DWORD
uint Period // DWORD
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ChangeTimerQueueTimer(
TimerQueue As IntPtr, ' HANDLE optional
Timer As IntPtr, ' HANDLE in/out
DueTime As UInteger, ' DWORD
Period As UInteger ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' TimerQueue : HANDLE optional
' Timer : HANDLE in/out
' DueTime : DWORD
' Period : DWORD
Declare PtrSafe Function ChangeTimerQueueTimer Lib "kernel32" ( _
ByVal TimerQueue As LongPtr, _
ByVal Timer As LongPtr, _
ByVal DueTime As Long, _
ByVal Period As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
ChangeTimerQueueTimer = ctypes.windll.kernel32.ChangeTimerQueueTimer
ChangeTimerQueueTimer.restype = wintypes.BOOL
ChangeTimerQueueTimer.argtypes = [
wintypes.HANDLE, # TimerQueue : HANDLE optional
wintypes.HANDLE, # Timer : HANDLE in/out
wintypes.DWORD, # DueTime : DWORD
wintypes.DWORD, # Period : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
ChangeTimerQueueTimer = Fiddle::Function.new(
lib['ChangeTimerQueueTimer'],
[
Fiddle::TYPE_VOIDP, # TimerQueue : HANDLE optional
Fiddle::TYPE_VOIDP, # Timer : HANDLE in/out
-Fiddle::TYPE_INT, # DueTime : DWORD
-Fiddle::TYPE_INT, # Period : DWORD
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn ChangeTimerQueueTimer(
TimerQueue: *mut core::ffi::c_void, // HANDLE optional
Timer: *mut core::ffi::c_void, // HANDLE in/out
DueTime: u32, // DWORD
Period: u32 // DWORD
) -> 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 ChangeTimerQueueTimer(IntPtr TimerQueue, IntPtr Timer, uint DueTime, uint Period);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ChangeTimerQueueTimer' -Namespace Win32 -PassThru
# $api::ChangeTimerQueueTimer(TimerQueue, Timer, DueTime, Period)#uselib "KERNEL32.dll"
#func global ChangeTimerQueueTimer "ChangeTimerQueueTimer" sptr, sptr, sptr, sptr
; ChangeTimerQueueTimer TimerQueue, Timer, DueTime, Period ; 戻り値は stat
; TimerQueue : HANDLE optional -> "sptr"
; Timer : HANDLE in/out -> "sptr"
; DueTime : DWORD -> "sptr"
; Period : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global ChangeTimerQueueTimer "ChangeTimerQueueTimer" sptr, sptr, int, int
; res = ChangeTimerQueueTimer(TimerQueue, Timer, DueTime, Period)
; TimerQueue : HANDLE optional -> "sptr"
; Timer : HANDLE in/out -> "sptr"
; DueTime : DWORD -> "int"
; Period : DWORD -> "int"; BOOL ChangeTimerQueueTimer(HANDLE TimerQueue, HANDLE Timer, DWORD DueTime, DWORD Period)
#uselib "KERNEL32.dll"
#cfunc global ChangeTimerQueueTimer "ChangeTimerQueueTimer" intptr, intptr, int, int
; res = ChangeTimerQueueTimer(TimerQueue, Timer, DueTime, Period)
; TimerQueue : HANDLE optional -> "intptr"
; Timer : HANDLE in/out -> "intptr"
; DueTime : DWORD -> "int"
; Period : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procChangeTimerQueueTimer = kernel32.NewProc("ChangeTimerQueueTimer")
)
// TimerQueue (HANDLE optional), Timer (HANDLE in/out), DueTime (DWORD), Period (DWORD)
r1, _, err := procChangeTimerQueueTimer.Call(
uintptr(TimerQueue),
uintptr(Timer),
uintptr(DueTime),
uintptr(Period),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction ChangeTimerQueueTimer(
TimerQueue: THandle; // HANDLE optional
Timer: THandle; // HANDLE in/out
DueTime: DWORD; // DWORD
Period: DWORD // DWORD
): BOOL; stdcall;
external 'KERNEL32.dll' name 'ChangeTimerQueueTimer';result := DllCall("KERNEL32\ChangeTimerQueueTimer"
, "Ptr", TimerQueue ; HANDLE optional
, "Ptr", Timer ; HANDLE in/out
, "UInt", DueTime ; DWORD
, "UInt", Period ; DWORD
, "Int") ; return: BOOL●ChangeTimerQueueTimer(TimerQueue, Timer, DueTime, Period) = DLL("KERNEL32.dll", "bool ChangeTimerQueueTimer(void*, void*, dword, dword)")
# 呼び出し: ChangeTimerQueueTimer(TimerQueue, Timer, DueTime, Period)
# TimerQueue : HANDLE optional -> "void*"
# Timer : HANDLE in/out -> "void*"
# DueTime : DWORD -> "dword"
# Period : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn ChangeTimerQueueTimer(
TimerQueue: ?*anyopaque, // HANDLE optional
Timer: ?*anyopaque, // HANDLE in/out
DueTime: u32, // DWORD
Period: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc ChangeTimerQueueTimer(
TimerQueue: pointer, # HANDLE optional
Timer: pointer, # HANDLE in/out
DueTime: uint32, # DWORD
Period: uint32 # DWORD
): int32 {.importc: "ChangeTimerQueueTimer", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int ChangeTimerQueueTimer(
void* TimerQueue, // HANDLE optional
void* Timer, // HANDLE in/out
uint DueTime, // DWORD
uint Period // DWORD
);ccall((:ChangeTimerQueueTimer, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{Cvoid}, UInt32, UInt32),
TimerQueue, Timer, DueTime, Period)
# TimerQueue : HANDLE optional -> Ptr{Cvoid}
# Timer : HANDLE in/out -> Ptr{Cvoid}
# DueTime : DWORD -> UInt32
# Period : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t ChangeTimerQueueTimer(
void* TimerQueue,
void* Timer,
uint32_t DueTime,
uint32_t Period);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.ChangeTimerQueueTimer(TimerQueue, Timer, DueTime, Period)
-- TimerQueue : HANDLE optional
-- Timer : HANDLE in/out
-- DueTime : DWORD
-- Period : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const ChangeTimerQueueTimer = lib.func('__stdcall', 'ChangeTimerQueueTimer', 'int32_t', ['void *', 'void *', 'uint32_t', 'uint32_t']);
// ChangeTimerQueueTimer(TimerQueue, Timer, DueTime, Period)
// TimerQueue : HANDLE optional -> 'void *'
// Timer : HANDLE in/out -> 'void *'
// DueTime : DWORD -> 'uint32_t'
// Period : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
ChangeTimerQueueTimer: { parameters: ["pointer", "pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.ChangeTimerQueueTimer(TimerQueue, Timer, DueTime, Period)
// TimerQueue : HANDLE optional -> "pointer"
// Timer : HANDLE in/out -> "pointer"
// DueTime : DWORD -> "u32"
// Period : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t ChangeTimerQueueTimer(
void* TimerQueue,
void* Timer,
uint32_t DueTime,
uint32_t Period);
C, "KERNEL32.dll");
// $ffi->ChangeTimerQueueTimer(TimerQueue, Timer, DueTime, Period);
// TimerQueue : HANDLE optional
// Timer : HANDLE in/out
// DueTime : DWORD
// Period : 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 Kernel32 extends StdCallLibrary {
Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
boolean ChangeTimerQueueTimer(
Pointer TimerQueue, // HANDLE optional
Pointer Timer, // HANDLE in/out
int DueTime, // DWORD
int Period // DWORD
);
}@[Link("kernel32")]
lib LibKERNEL32
fun ChangeTimerQueueTimer = ChangeTimerQueueTimer(
TimerQueue : Void*, # HANDLE optional
Timer : Void*, # HANDLE in/out
DueTime : UInt32, # DWORD
Period : 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 ChangeTimerQueueTimerNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Uint32);
typedef ChangeTimerQueueTimerDart = int Function(Pointer<Void>, Pointer<Void>, int, int);
final ChangeTimerQueueTimer = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<ChangeTimerQueueTimerNative, ChangeTimerQueueTimerDart>('ChangeTimerQueueTimer');
// TimerQueue : HANDLE optional -> Pointer<Void>
// Timer : HANDLE in/out -> Pointer<Void>
// DueTime : DWORD -> Uint32
// Period : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function ChangeTimerQueueTimer(
TimerQueue: THandle; // HANDLE optional
Timer: THandle; // HANDLE in/out
DueTime: DWORD; // DWORD
Period: DWORD // DWORD
): BOOL; stdcall;
external 'KERNEL32.dll' name 'ChangeTimerQueueTimer';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "ChangeTimerQueueTimer"
c_ChangeTimerQueueTimer :: Ptr () -> Ptr () -> Word32 -> Word32 -> IO CInt
-- TimerQueue : HANDLE optional -> Ptr ()
-- Timer : HANDLE in/out -> Ptr ()
-- DueTime : DWORD -> Word32
-- Period : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let changetimerqueuetimer =
foreign "ChangeTimerQueueTimer"
((ptr void) @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* TimerQueue : HANDLE optional -> (ptr void) *)
(* Timer : HANDLE in/out -> (ptr void) *)
(* DueTime : DWORD -> uint32_t *)
(* Period : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("ChangeTimerQueueTimer" change-timer-queue-timer :convention :stdcall) :int32
(timer-queue :pointer) ; HANDLE optional
(timer :pointer) ; HANDLE in/out
(due-time :uint32) ; DWORD
(period :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $ChangeTimerQueueTimer = Win32::API::More->new('KERNEL32',
'BOOL ChangeTimerQueueTimer(HANDLE TimerQueue, HANDLE Timer, DWORD DueTime, DWORD Period)');
# my $ret = $ChangeTimerQueueTimer->Call($TimerQueue, $Timer, $DueTime, $Period);
# TimerQueue : HANDLE optional -> HANDLE
# Timer : HANDLE in/out -> HANDLE
# DueTime : DWORD -> DWORD
# Period : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f CreateTimerQueue — タイマーキューを作成する。
- f CreateTimerQueueTimer — タイマーキューにタイマーを作成する。
- f DeleteTimerQueueTimer — タイマーキュータイマーを削除する。