ホーム › System.Threading › CreateWaitableTimerExW

CreateWaitableTimerExW

関数

アクセス権とフラグを指定して待機可能タイマーを作成する(Unicode版)。

DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

HANDLE CreateWaitableTimerExW(
    SECURITY_ATTRIBUTES* lpTimerAttributes,   // optional
    LPCWSTR lpTimerName,   // optional
    DWORD dwFlags,
    DWORD dwDesiredAccess
);

パラメーター

名前

型

方向

説明

lpTimerAttributes

SECURITY_ATTRIBUTES*

inoptional

SECURITY_ATTRIBUTES 構造体へのポインターです。このパラメーターが NULL の場合、タイマーハンドルは子プロセスに継承されません。

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

lpTimerName

LPCWSTR

inoptional

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

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

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

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

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

dwFlags

DWORD

このパラメーターには 0 または次の値を指定できます。

値	意味
CREATE_WAITABLE_TIMER_MANUAL_RESET 0x00000001	タイマーは手動でリセットする必要があります。これを指定しない場合、システムは待機中のスレッドを1つ解放した後、タイマーを自動的にリセットします。
CREATE_WAITABLE_TIMER_HIGH_RESOLUTION 0x00000002	高分解能タイマーを作成します。数ミリ秒程度の短い満了遅延も許容できない、時間的にクリティカルな状況でこの値を使用します。この値は Windows 10 バージョン 1803 以降でサポートされます。

dwDesiredAccess

DWORD

タイマーオブジェクトのアクセスマスクです。アクセス権の一覧については、 Synchronization Object Security and Access Rights を参照してください。

戻り値の型: HANDLE

公式ドキュメント

待機可能タイマーオブジェクトを作成または開き、そのオブジェクトへのハンドルを返します。

戻り値

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

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

解説(Remarks)

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

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

CreateProcess 関数によって作成されたプロセスは、CreateWaitableTimerEx の lpTimerAttributes パラメーターが継承を有効にしている場合、タイマーオブジェクトへのハンドルを継承できます。
プロセスは DuplicateHandle 関数の呼び出しでタイマーオブジェクトハンドルを指定できます。その結果得られるハンドルは、別のプロセスで使用できます。
プロセスは OpenWaitableTimer 関数または CreateWaitableTimerEx 関数の呼び出しでタイマーオブジェクトの名前を指定できます。

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 CreateWaitableTimerExW(
    SECURITY_ATTRIBUTES* lpTimerAttributes,   // optional
    LPCWSTR lpTimerName,   // optional
    DWORD dwFlags,
    DWORD dwDesiredAccess
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateWaitableTimerExW(
    IntPtr lpTimerAttributes,   // SECURITY_ATTRIBUTES* optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpTimerName,   // LPCWSTR optional
    uint dwFlags,   // DWORD
    uint dwDesiredAccess   // DWORD
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateWaitableTimerExW(
    lpTimerAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* optional
    <MarshalAs(UnmanagedType.LPWStr)> lpTimerName As String,   ' LPCWSTR optional
    dwFlags As UInteger,   ' DWORD
    dwDesiredAccess As UInteger   ' DWORD
) As IntPtr
End Function

' lpTimerAttributes : SECURITY_ATTRIBUTES* optional
' lpTimerName : LPCWSTR optional
' dwFlags : DWORD
' dwDesiredAccess : DWORD
Declare PtrSafe Function CreateWaitableTimerExW Lib "kernel32" ( _
    ByVal lpTimerAttributes As LongPtr, _
    ByVal lpTimerName As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal dwDesiredAccess As Long) 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

CreateWaitableTimerExW = ctypes.windll.kernel32.CreateWaitableTimerExW
CreateWaitableTimerExW.restype = ctypes.c_void_p
CreateWaitableTimerExW.argtypes = [
    ctypes.c_void_p,  # lpTimerAttributes : SECURITY_ATTRIBUTES* optional
    wintypes.LPCWSTR,  # lpTimerName : LPCWSTR optional
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.DWORD,  # dwDesiredAccess : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CreateWaitableTimerExW = Fiddle::Function.new(
  lib['CreateWaitableTimerExW'],
  [
    Fiddle::TYPE_VOIDP,  # lpTimerAttributes : SECURITY_ATTRIBUTES* optional
    Fiddle::TYPE_VOIDP,  # lpTimerName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    -Fiddle::TYPE_INT,  # dwDesiredAccess : DWORD
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn CreateWaitableTimerExW(
        lpTimerAttributes: *mut SECURITY_ATTRIBUTES,  // SECURITY_ATTRIBUTES* optional
        lpTimerName: *const u16,  // LPCWSTR optional
        dwFlags: u32,  // DWORD
        dwDesiredAccess: u32  // DWORD
    ) -> *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 CreateWaitableTimerExW(IntPtr lpTimerAttributes, [MarshalAs(UnmanagedType.LPWStr)] string lpTimerName, uint dwFlags, uint dwDesiredAccess);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateWaitableTimerExW' -Namespace Win32 -PassThru
# $api::CreateWaitableTimerExW(lpTimerAttributes, lpTimerName, dwFlags, dwDesiredAccess)

#uselib "KERNEL32.dll"
#func global CreateWaitableTimerExW "CreateWaitableTimerExW" wptr, wptr, wptr, wptr
; CreateWaitableTimerExW varptr(lpTimerAttributes), lpTimerName, dwFlags, dwDesiredAccess   ; 戻り値は stat
; lpTimerAttributes : SECURITY_ATTRIBUTES* optional -> "wptr"
; lpTimerName : LPCWSTR optional -> "wptr"
; dwFlags : DWORD -> "wptr"
; dwDesiredAccess : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global CreateWaitableTimerExW "CreateWaitableTimerExW" var, wstr, int, int
; res = CreateWaitableTimerExW(lpTimerAttributes, lpTimerName, dwFlags, dwDesiredAccess)
; lpTimerAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; lpTimerName : LPCWSTR optional -> "wstr"
; dwFlags : DWORD -> "int"
; dwDesiredAccess : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global CreateWaitableTimerExW "CreateWaitableTimerExW" sptr, wstr, int, int
; res = CreateWaitableTimerExW(varptr(lpTimerAttributes), lpTimerName, dwFlags, dwDesiredAccess)
; lpTimerAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; lpTimerName : LPCWSTR optional -> "wstr"
; dwFlags : DWORD -> "int"
; dwDesiredAccess : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。