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

CreateWaitableTimerA

関数
待機可能タイマーオブジェクトを作成する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

HANDLE CreateWaitableTimerA(
    SECURITY_ATTRIBUTES* lpTimerAttributes,   // optional
    BOOL bManualReset,
    LPCSTR lpTimerName   // optional
);

パラメーター

名前型方向説明
lpTimerAttributesSECURITY_ATTRIBUTES*inoptional

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

lpTimerAttributes が NULL の場合、タイマーオブジェクトには既定のセキュリティ記述子が設定され、ハンドルは継承できません。タイマーの既定のセキュリティ記述子内の ACL は、作成者のプライマリトークンまたは偽装トークンに由来します。

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

タイマーオブジェクトの名前です。名前は 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  (ANSI / -A)
#include <windows.h>

HANDLE CreateWaitableTimerA(
    SECURITY_ATTRIBUTES* lpTimerAttributes,   // optional
    BOOL bManualReset,
    LPCSTR lpTimerName   // optional
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr CreateWaitableTimerA(
    IntPtr lpTimerAttributes,   // SECURITY_ATTRIBUTES* optional
    bool bManualReset,   // BOOL
    [MarshalAs(UnmanagedType.LPStr)] string lpTimerName   // LPCSTR optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function CreateWaitableTimerA(
    lpTimerAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* optional
    bManualReset As Boolean,   ' BOOL
    <MarshalAs(UnmanagedType.LPStr)> lpTimerName As String   ' LPCSTR optional
) As IntPtr
End Function
' lpTimerAttributes : SECURITY_ATTRIBUTES* optional
' bManualReset : BOOL
' lpTimerName : LPCSTR optional
Declare PtrSafe Function CreateWaitableTimerA Lib "kernel32" ( _
    ByVal lpTimerAttributes As LongPtr, _
    ByVal bManualReset As Long, _
    ByVal lpTimerName As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateWaitableTimerA = ctypes.windll.kernel32.CreateWaitableTimerA
CreateWaitableTimerA.restype = ctypes.c_void_p
CreateWaitableTimerA.argtypes = [
    ctypes.c_void_p,  # lpTimerAttributes : SECURITY_ATTRIBUTES* optional
    wintypes.BOOL,  # bManualReset : BOOL
    wintypes.LPCSTR,  # lpTimerName : LPCSTR optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateWaitableTimerA = kernel32.NewProc("CreateWaitableTimerA")
)

// lpTimerAttributes (SECURITY_ATTRIBUTES* optional), bManualReset (BOOL), lpTimerName (LPCSTR optional)
r1, _, err := procCreateWaitableTimerA.Call(
	uintptr(lpTimerAttributes),
	uintptr(bManualReset),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpTimerName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function CreateWaitableTimerA(
  lpTimerAttributes: Pointer;   // SECURITY_ATTRIBUTES* optional
  bManualReset: BOOL;   // BOOL
  lpTimerName: PAnsiChar   // LPCSTR optional
): THandle; stdcall;
  external 'KERNEL32.dll' name 'CreateWaitableTimerA';
result := DllCall("KERNEL32\CreateWaitableTimerA"
    , "Ptr", lpTimerAttributes   ; SECURITY_ATTRIBUTES* optional
    , "Int", bManualReset   ; BOOL
    , "AStr", lpTimerName   ; LPCSTR optional
    , "Ptr")   ; return: HANDLE
●CreateWaitableTimerA(lpTimerAttributes, bManualReset, lpTimerName) = DLL("KERNEL32.dll", "void* CreateWaitableTimerA(void*, bool, char*)")
# 呼び出し: CreateWaitableTimerA(lpTimerAttributes, bManualReset, lpTimerName)
# lpTimerAttributes : SECURITY_ATTRIBUTES* optional -> "void*"
# bManualReset : BOOL -> "bool"
# lpTimerName : LPCSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

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

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

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

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

関連項目

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