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

CreateTimerQueue

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

シグネチャ

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

HANDLE CreateTimerQueue(void);

パラメーターなし。戻り値: HANDLE

公式ドキュメント

タイマーのキューを作成します。

戻り値

関数が成功した場合、戻り値はタイマーキューへのハンドルです。このハンドルは、タイマーキューへのハンドルを必要とする関数でのみ使用できます。

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

解説(Remarks)

タイマーをキューに追加するには、 CreateTimerQueueTimer 関数を呼び出します。タイマーをキューから削除するには、 DeleteTimerQueueTimer 関数を呼び出します。

タイマーのキューの使用が終わったら、 DeleteTimerQueueEx 関数を呼び出してタイマーキューを削除します。キュー内の保留中のタイマーはすべてキャンセルされ、削除されます。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0500 以降として定義します。詳細については、 Using the Windows Headers を参照してください。

使用例

CreateTimerQueue を使用する例については、 Using Timer Queues を参照してください。

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

各言語での呼び出し定義

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

HANDLE CreateTimerQueue(void);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateTimerQueue();
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateTimerQueue() As IntPtr
End Function
Declare PtrSafe Function CreateTimerQueue Lib "kernel32" () As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateTimerQueue = ctypes.windll.kernel32.CreateTimerQueue
CreateTimerQueue.restype = ctypes.c_void_p
CreateTimerQueue.argtypes = []
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CreateTimerQueue = Fiddle::Function.new(
  lib['CreateTimerQueue'],
  [],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn CreateTimerQueue() -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern IntPtr CreateTimerQueue();
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateTimerQueue' -Namespace Win32 -PassThru
# $api::CreateTimerQueue()
#uselib "KERNEL32.dll"
#func global CreateTimerQueue "CreateTimerQueue"
; CreateTimerQueue   ; 戻り値は stat
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global CreateTimerQueue "CreateTimerQueue"
; res = CreateTimerQueue()
; HANDLE CreateTimerQueue()
#uselib "KERNEL32.dll"
#cfunc global CreateTimerQueue "CreateTimerQueue"
; res = CreateTimerQueue()
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateTimerQueue = kernel32.NewProc("CreateTimerQueue")
)

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

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

typedef CreateTimerQueueNative = Pointer<Void> Function();
typedef CreateTimerQueueDart = Pointer<Void> Function();
final CreateTimerQueue = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateTimerQueueNative, CreateTimerQueueDart>('CreateTimerQueue');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateTimerQueue: THandle; stdcall;
  external 'KERNEL32.dll' name 'CreateTimerQueue';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let createtimerqueue =
  foreign "CreateTimerQueue"
    (void @-> returning (ptr void))
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CreateTimerQueue" create-timer-queue :convention :stdcall) :pointer)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateTimerQueue = Win32::API::More->new('KERNEL32',
    'HANDLE CreateTimerQueue()');
# my $ret = $CreateTimerQueue->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目