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

CreateWaitableTimerW

関数
名前付きまたは無名の待機可能タイマーを作成する(Unicode版)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

HANDLE CreateWaitableTimerW(
    SECURITY_ATTRIBUTES* lpTimerAttributes,   // optional
    BOOL bManualReset,
    LPCWSTR lpTimerName   // optional
);

パラメーター

名前型方向説明
lpTimerAttributesSECURITY_ATTRIBUTES*inoptional

新しいタイマー オブジェクトのセキュリティ記述子を指定し、返されるハンドルを子プロセスが継承できるかどうかを決定する SECURITY_ATTRIBUTES 構造体へのポインターです。

lpTimerAttributes が NULL の場合、タイマー オブジェクトには既定のセキュリティ記述子が割り当てられ、ハンドルは継承できません。タイマーの既定のセキュリティ記述子に含まれる ACL は、作成者のプライマリ トークンまたは偽装トークンから取得されます。

bManualResetBOOLinこのパラメーターが TRUE の場合、タイマーは手動リセットの通知タイマーになります。それ以外の場合、タイマーは同期タイマーになります。
lpTimerNameLPCWSTRinoptional

タイマー オブジェクトの名前です。名前は MAX_PATH 文字に制限されます。名前の比較では大文字と小文字が区別されます。

lpTimerName が NULL の場合、タイマー オブジェクトは名前なしで作成されます。

lpTimerName が既存のイベント、セマフォ、ミューテックス、ジョブ、またはファイル マッピング オブジェクトの名前と一致する場合、関数は失敗し、 GetLastError は ERROR_INVALID_HANDLE を返します。これは、これらのオブジェクトが同じ名前空間を共有するために発生します。

名前には "Global" または "Local" プレフィックスを付けて、グローバル名前空間またはセッション名前空間に明示的にオブジェクトを作成できます。名前の残りの部分には、円記号 (\) を除く任意の文字を含めることができます。詳細については、 Kernel Object Namespaces を参照してください。高速ユーザー切り替えはターミナル サービス セッションを使用して実装されています。アプリケーションが複数のユーザーをサポートできるように、カーネル オブジェクト名はターミナル サービス向けに示されたガイドラインに従う必要があります。

オブジェクトはプライベート名前空間に作成できます。詳細については、Object Namespaces を参照してください。

戻り値の型: HANDLE

公式ドキュメント

待機可能タイマー オブジェクトを作成または開きます。

戻り値

関数が成功した場合、戻り値はタイマー オブジェクトへのハンドルです。名前付きタイマー オブジェクトが関数呼び出し前に存在していた場合、関数は既存のオブジェクトへのハンドルを返し、 GetLastError は ERROR_ALREADY_EXISTS を返します。

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

解説(Remarks)

CreateWaitableTimer によって返されるハンドルは TIMER_ALL_ACCESS アクセス権で作成されます。呼び出し元にアクセスが許可されている限り、タイマー オブジェクトへのハンドルを必要とする任意の関数で使用できます。別のユーザーを偽装しているサービスまたはスレッドからタイマーを作成する場合は、タイマー作成時にセキュリティ記述子を適用するか、作成プロセスの既定の DACL を変更して既定のセキュリティ記述子を変更できます。詳細については、 Synchronization Object Security and Access Rights を参照してください。

呼び出し元プロセスの任意のスレッドは、いずれかの 待機関数 の呼び出しでタイマー オブジェクト ハンドルを指定できます。

複数のプロセスが同じタイマー オブジェクトへのハンドルを持つことができ、プロセス間同期にオブジェクトを使用できます。

ハンドルを閉じるには、CloseHandle 関数を使用します。プロセスが終了すると、システムは自動的にハンドルを閉じます。タイマー オブジェクトは、その最後のハンドルが閉じられたときに破棄されます。

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

タイマーをウィンドウに関連付けるには、SetTimer 関数を使用します。

例

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

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

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

HANDLE CreateWaitableTimerW(
    SECURITY_ATTRIBUTES* lpTimerAttributes,   // optional
    BOOL bManualReset,
    LPCWSTR lpTimerName   // optional
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateWaitableTimerW(
    IntPtr lpTimerAttributes,   // SECURITY_ATTRIBUTES* optional
    bool bManualReset,   // BOOL
    [MarshalAs(UnmanagedType.LPWStr)] string lpTimerName   // LPCWSTR optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateWaitableTimerW(
    lpTimerAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* optional
    bManualReset As Boolean,   ' BOOL
    <MarshalAs(UnmanagedType.LPWStr)> lpTimerName As String   ' LPCWSTR optional
) As IntPtr
End Function
' lpTimerAttributes : SECURITY_ATTRIBUTES* optional
' bManualReset : BOOL
' lpTimerName : LPCWSTR optional
Declare PtrSafe Function CreateWaitableTimerW Lib "kernel32" ( _
    ByVal lpTimerAttributes As LongPtr, _
    ByVal bManualReset As Long, _
    ByVal lpTimerName As LongPtr) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateWaitableTimerW = ctypes.windll.kernel32.CreateWaitableTimerW
CreateWaitableTimerW.restype = ctypes.c_void_p
CreateWaitableTimerW.argtypes = [
    ctypes.c_void_p,  # lpTimerAttributes : SECURITY_ATTRIBUTES* optional
    wintypes.BOOL,  # bManualReset : BOOL
    wintypes.LPCWSTR,  # lpTimerName : LPCWSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CreateWaitableTimerW = Fiddle::Function.new(
  lib['CreateWaitableTimerW'],
  [
    Fiddle::TYPE_VOIDP,  # lpTimerAttributes : SECURITY_ATTRIBUTES* optional
    Fiddle::TYPE_INT,  # bManualReset : BOOL
    Fiddle::TYPE_VOIDP,  # lpTimerName : LPCWSTR optional
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn CreateWaitableTimerW(
        lpTimerAttributes: *mut SECURITY_ATTRIBUTES,  // SECURITY_ATTRIBUTES* optional
        bManualReset: i32,  // BOOL
        lpTimerName: *const u16  // LPCWSTR optional
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern IntPtr CreateWaitableTimerW(IntPtr lpTimerAttributes, bool bManualReset, [MarshalAs(UnmanagedType.LPWStr)] string lpTimerName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateWaitableTimerW' -Namespace Win32 -PassThru
# $api::CreateWaitableTimerW(lpTimerAttributes, bManualReset, lpTimerName)
#uselib "KERNEL32.dll"
#func global CreateWaitableTimerW "CreateWaitableTimerW" wptr, wptr, wptr
; CreateWaitableTimerW varptr(lpTimerAttributes), bManualReset, lpTimerName   ; 戻り値は stat
; lpTimerAttributes : SECURITY_ATTRIBUTES* optional -> "wptr"
; bManualReset : BOOL -> "wptr"
; lpTimerName : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "KERNEL32.dll"
#cfunc global CreateWaitableTimerW "CreateWaitableTimerW" var, int, wstr
; res = CreateWaitableTimerW(lpTimerAttributes, bManualReset, lpTimerName)
; lpTimerAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; bManualReset : BOOL -> "int"
; lpTimerName : LPCWSTR optional -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; HANDLE CreateWaitableTimerW(SECURITY_ATTRIBUTES* lpTimerAttributes, BOOL bManualReset, LPCWSTR lpTimerName)
#uselib "KERNEL32.dll"
#cfunc global CreateWaitableTimerW "CreateWaitableTimerW" var, int, wstr
; res = CreateWaitableTimerW(lpTimerAttributes, bManualReset, lpTimerName)
; lpTimerAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; bManualReset : BOOL -> "int"
; lpTimerName : LPCWSTR optional -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateWaitableTimerW = kernel32.NewProc("CreateWaitableTimerW")
)

// lpTimerAttributes (SECURITY_ATTRIBUTES* optional), bManualReset (BOOL), lpTimerName (LPCWSTR optional)
r1, _, err := procCreateWaitableTimerW.Call(
	uintptr(lpTimerAttributes),
	uintptr(bManualReset),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpTimerName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function CreateWaitableTimerW(
  lpTimerAttributes: Pointer;   // SECURITY_ATTRIBUTES* optional
  bManualReset: BOOL;   // BOOL
  lpTimerName: PWideChar   // LPCWSTR optional
): THandle; stdcall;
  external 'KERNEL32.dll' name 'CreateWaitableTimerW';
result := DllCall("KERNEL32\CreateWaitableTimerW"
    , "Ptr", lpTimerAttributes   ; SECURITY_ATTRIBUTES* optional
    , "Int", bManualReset   ; BOOL
    , "WStr", lpTimerName   ; LPCWSTR optional
    , "Ptr")   ; return: HANDLE
●CreateWaitableTimerW(lpTimerAttributes, bManualReset, lpTimerName) = DLL("KERNEL32.dll", "void* CreateWaitableTimerW(void*, bool, char*)")
# 呼び出し: CreateWaitableTimerW(lpTimerAttributes, bManualReset, lpTimerName)
# lpTimerAttributes : SECURITY_ATTRIBUTES* optional -> "void*"
# bManualReset : BOOL -> "bool"
# lpTimerName : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn CreateWaitableTimerW(
    lpTimerAttributes: [*c]SECURITY_ATTRIBUTES, // SECURITY_ATTRIBUTES* optional
    bManualReset: i32, // BOOL
    lpTimerName: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) ?*anyopaque;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc CreateWaitableTimerW(
    lpTimerAttributes: ptr SECURITY_ATTRIBUTES,  # SECURITY_ATTRIBUTES* optional
    bManualReset: int32,  # BOOL
    lpTimerName: WideCString  # LPCWSTR optional
): pointer {.importc: "CreateWaitableTimerW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
void* CreateWaitableTimerW(
    SECURITY_ATTRIBUTES* lpTimerAttributes,   // SECURITY_ATTRIBUTES* optional
    int bManualReset,   // BOOL
    const(wchar)* lpTimerName   // LPCWSTR optional
);
ccall((:CreateWaitableTimerW, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
      (Ptr{SECURITY_ATTRIBUTES}, Int32, Cwstring),
      lpTimerAttributes, bManualReset, lpTimerName)
# lpTimerAttributes : SECURITY_ATTRIBUTES* optional -> Ptr{SECURITY_ATTRIBUTES}
# bManualReset : BOOL -> Int32
# lpTimerName : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void* CreateWaitableTimerW(
    void* lpTimerAttributes,
    int32_t bManualReset,
    const uint16_t* lpTimerName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CreateWaitableTimerW(lpTimerAttributes, bManualReset, lpTimerName)
-- lpTimerAttributes : SECURITY_ATTRIBUTES* optional
-- bManualReset : BOOL
-- lpTimerName : LPCWSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CreateWaitableTimerW = lib.func('__stdcall', 'CreateWaitableTimerW', 'void *', ['void *', 'int32_t', 'str16']);
// CreateWaitableTimerW(lpTimerAttributes, bManualReset, lpTimerName)
// lpTimerAttributes : SECURITY_ATTRIBUTES* optional -> 'void *'
// bManualReset : BOOL -> 'int32_t'
// lpTimerName : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  CreateWaitableTimerW: { parameters: ["pointer", "i32", "buffer"], result: "pointer" },
});
// lib.symbols.CreateWaitableTimerW(lpTimerAttributes, bManualReset, lpTimerName)
// lpTimerAttributes : SECURITY_ATTRIBUTES* optional -> "pointer"
// bManualReset : BOOL -> "i32"
// lpTimerName : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* CreateWaitableTimerW(
    void* lpTimerAttributes,
    int32_t bManualReset,
    const uint16_t* lpTimerName);
C, "KERNEL32.dll");
// $ffi->CreateWaitableTimerW(lpTimerAttributes, bManualReset, lpTimerName);
// lpTimerAttributes : SECURITY_ATTRIBUTES* optional
// bManualReset : BOOL
// lpTimerName : LPCWSTR optional
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    Pointer CreateWaitableTimerW(
        Pointer lpTimerAttributes,   // SECURITY_ATTRIBUTES* optional
        boolean bManualReset,   // BOOL
        WString lpTimerName   // LPCWSTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun CreateWaitableTimerW = CreateWaitableTimerW(
    lpTimerAttributes : SECURITY_ATTRIBUTES*,   # SECURITY_ATTRIBUTES* optional
    bManualReset : Int32,   # BOOL
    lpTimerName : UInt16*   # LPCWSTR optional
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CreateWaitableTimerWNative = Pointer<Void> Function(Pointer<Void>, Int32, Pointer<Utf16>);
typedef CreateWaitableTimerWDart = Pointer<Void> Function(Pointer<Void>, int, Pointer<Utf16>);
final CreateWaitableTimerW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateWaitableTimerWNative, CreateWaitableTimerWDart>('CreateWaitableTimerW');
// lpTimerAttributes : SECURITY_ATTRIBUTES* optional -> Pointer<Void>
// bManualReset : BOOL -> Int32
// lpTimerName : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateWaitableTimerW(
  lpTimerAttributes: Pointer;   // SECURITY_ATTRIBUTES* optional
  bManualReset: BOOL;   // BOOL
  lpTimerName: PWideChar   // LPCWSTR optional
): THandle; stdcall;
  external 'KERNEL32.dll' name 'CreateWaitableTimerW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateWaitableTimerW"
  c_CreateWaitableTimerW :: Ptr () -> CInt -> CWString -> IO (Ptr ())
-- lpTimerAttributes : SECURITY_ATTRIBUTES* optional -> Ptr ()
-- bManualReset : BOOL -> CInt
-- lpTimerName : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createwaitabletimerw =
  foreign "CreateWaitableTimerW"
    ((ptr void) @-> int32_t @-> (ptr uint16_t) @-> returning (ptr void))
(* lpTimerAttributes : SECURITY_ATTRIBUTES* optional -> (ptr void) *)
(* bManualReset : BOOL -> int32_t *)
(* lpTimerName : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CreateWaitableTimerW" create-waitable-timer-w :convention :stdcall) :pointer
  (lp-timer-attributes :pointer)   ; SECURITY_ATTRIBUTES* optional
  (b-manual-reset :int32)   ; BOOL
  (lp-timer-name (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateWaitableTimerW = Win32::API::More->new('KERNEL32',
    'HANDLE CreateWaitableTimerW(LPVOID lpTimerAttributes, BOOL bManualReset, LPCWSTR lpTimerName)');
# my $ret = $CreateWaitableTimerW->Call($lpTimerAttributes, $bManualReset, $lpTimerName);
# lpTimerAttributes : SECURITY_ATTRIBUTES* optional -> LPVOID
# bManualReset : BOOL -> BOOL
# lpTimerName : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
公式の関連項目
使用する型