OpenWaitableTimerW
関数シグネチャ
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
HANDLE OpenWaitableTimerW(
SYNCHRONIZATION_ACCESS_RIGHTS dwDesiredAccess,
BOOL bInheritHandle,
LPCWSTR lpTimerName
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| dwDesiredAccess | SYNCHRONIZATION_ACCESS_RIGHTS | in | タイマーオブジェクトへのアクセス権。指定したオブジェクトのセキュリティ記述子が、呼び出し元プロセスに対して要求されたアクセスを許可していない場合、この関数は失敗します。アクセス権の一覧については、Synchronization Object Security and Access Rights を参照してください。 |
| bInheritHandle | BOOL | in | この値が TRUE の場合、このプロセスによって作成されるプロセスはハンドルを継承します。それ以外の場合、プロセスはこのハンドルを継承しません。 |
| lpTimerName | LPCWSTR | in | タイマーオブジェクトの名前。名前は MAX_PATH 文字までに制限されます。名前の比較では大文字と小文字が区別されます。 この関数はプライベート名前空間内のオブジェクトを開くことができます。詳細については、Object Namespaces を参照してください。 ターミナルサービス: 名前には、グローバル名前空間またはセッション名前空間内のオブジェクトを明示的に開くために、"Global" または "Local" のプレフィックスを付けることができます。名前の残りの部分には、バックスラッシュ文字 (\) を除く任意の文字を含めることができます。詳細については、Kernel Object Namespaces を参照してください。 注 ユーザーの簡易切り替えはターミナルサービスのセッションを使用して実装されています。最初にログオンするユーザーはセッション 0 を使用し、次にログオンするユーザーはセッション 1 を使用する、というように続きます。アプリケーションが複数のユーザーをサポートできるよう、カーネルオブジェクト名はターミナルサービスについて定められたガイドラインに従う必要があります。 |
戻り値の型: HANDLE
公式ドキュメント
既存の名前付き待機可能タイマーオブジェクトを開きます。
戻り値
関数が成功した場合、戻り値はタイマーオブジェクトのハンドルです。
関数が失敗した場合、戻り値は NULL です。拡張エラー情報を取得するには、GetLastError を呼び出します。
解説(Remarks)
OpenWaitableTimer 関数を使用すると、複数のプロセスが同じタイマーオブジェクトへのハンドルを開くことができます。この関数は、いずれかのプロセスが CreateWaitableTimer 関数を使用してタイマーを既に作成している場合にのみ成功します。呼び出し元プロセスは、返されたハンドルを、wait 関数 など、タイマーオブジェクトのハンドルを必要とする任意の関数で使用できます。ただし、dwDesiredAccess パラメーターで指定されたアクセスの制限に従います。
返されたハンドルは、DuplicateHandle 関数を使用して複製できます。ハンドルを閉じるには、CloseHandle 関数を使用します。プロセスが終了すると、システムはハンドルを自動的に閉じます。タイマーオブジェクトは、その最後のハンドルが閉じられたときに破棄されます。
この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0400 以降として定義します。詳細については、Using the Windows Headers を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
HANDLE OpenWaitableTimerW(
SYNCHRONIZATION_ACCESS_RIGHTS dwDesiredAccess,
BOOL bInheritHandle,
LPCWSTR lpTimerName
);[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr OpenWaitableTimerW(
uint dwDesiredAccess, // SYNCHRONIZATION_ACCESS_RIGHTS
bool bInheritHandle, // BOOL
[MarshalAs(UnmanagedType.LPWStr)] string lpTimerName // LPCWSTR
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function OpenWaitableTimerW(
dwDesiredAccess As UInteger, ' SYNCHRONIZATION_ACCESS_RIGHTS
bInheritHandle As Boolean, ' BOOL
<MarshalAs(UnmanagedType.LPWStr)> lpTimerName As String ' LPCWSTR
) As IntPtr
End Function' dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS
' bInheritHandle : BOOL
' lpTimerName : LPCWSTR
Declare PtrSafe Function OpenWaitableTimerW Lib "kernel32" ( _
ByVal dwDesiredAccess As Long, _
ByVal bInheritHandle 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
OpenWaitableTimerW = ctypes.windll.kernel32.OpenWaitableTimerW
OpenWaitableTimerW.restype = ctypes.c_void_p
OpenWaitableTimerW.argtypes = [
wintypes.DWORD, # dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS
wintypes.BOOL, # bInheritHandle : BOOL
wintypes.LPCWSTR, # lpTimerName : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
OpenWaitableTimerW = Fiddle::Function.new(
lib['OpenWaitableTimerW'],
[
-Fiddle::TYPE_INT, # dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS
Fiddle::TYPE_INT, # bInheritHandle : BOOL
Fiddle::TYPE_VOIDP, # lpTimerName : LPCWSTR
],
Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "kernel32")]
extern "system" {
fn OpenWaitableTimerW(
dwDesiredAccess: u32, // SYNCHRONIZATION_ACCESS_RIGHTS
bInheritHandle: i32, // BOOL
lpTimerName: *const u16 // LPCWSTR
) -> *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 OpenWaitableTimerW(uint dwDesiredAccess, bool bInheritHandle, [MarshalAs(UnmanagedType.LPWStr)] string lpTimerName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_OpenWaitableTimerW' -Namespace Win32 -PassThru
# $api::OpenWaitableTimerW(dwDesiredAccess, bInheritHandle, lpTimerName)#uselib "KERNEL32.dll"
#func global OpenWaitableTimerW "OpenWaitableTimerW" wptr, wptr, wptr
; OpenWaitableTimerW dwDesiredAccess, bInheritHandle, lpTimerName ; 戻り値は stat
; dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> "wptr"
; bInheritHandle : BOOL -> "wptr"
; lpTimerName : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global OpenWaitableTimerW "OpenWaitableTimerW" int, int, wstr
; res = OpenWaitableTimerW(dwDesiredAccess, bInheritHandle, lpTimerName)
; dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> "int"
; bInheritHandle : BOOL -> "int"
; lpTimerName : LPCWSTR -> "wstr"; HANDLE OpenWaitableTimerW(SYNCHRONIZATION_ACCESS_RIGHTS dwDesiredAccess, BOOL bInheritHandle, LPCWSTR lpTimerName)
#uselib "KERNEL32.dll"
#cfunc global OpenWaitableTimerW "OpenWaitableTimerW" int, int, wstr
; res = OpenWaitableTimerW(dwDesiredAccess, bInheritHandle, lpTimerName)
; dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> "int"
; bInheritHandle : BOOL -> "int"
; lpTimerName : LPCWSTR -> "wstr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procOpenWaitableTimerW = kernel32.NewProc("OpenWaitableTimerW")
)
// dwDesiredAccess (SYNCHRONIZATION_ACCESS_RIGHTS), bInheritHandle (BOOL), lpTimerName (LPCWSTR)
r1, _, err := procOpenWaitableTimerW.Call(
uintptr(dwDesiredAccess),
uintptr(bInheritHandle),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpTimerName))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HANDLEfunction OpenWaitableTimerW(
dwDesiredAccess: DWORD; // SYNCHRONIZATION_ACCESS_RIGHTS
bInheritHandle: BOOL; // BOOL
lpTimerName: PWideChar // LPCWSTR
): THandle; stdcall;
external 'KERNEL32.dll' name 'OpenWaitableTimerW';result := DllCall("KERNEL32\OpenWaitableTimerW"
, "UInt", dwDesiredAccess ; SYNCHRONIZATION_ACCESS_RIGHTS
, "Int", bInheritHandle ; BOOL
, "WStr", lpTimerName ; LPCWSTR
, "Ptr") ; return: HANDLE●OpenWaitableTimerW(dwDesiredAccess, bInheritHandle, lpTimerName) = DLL("KERNEL32.dll", "void* OpenWaitableTimerW(dword, bool, char*)")
# 呼び出し: OpenWaitableTimerW(dwDesiredAccess, bInheritHandle, lpTimerName)
# dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> "dword"
# bInheritHandle : BOOL -> "bool"
# lpTimerName : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "kernel32" fn OpenWaitableTimerW(
dwDesiredAccess: u32, // SYNCHRONIZATION_ACCESS_RIGHTS
bInheritHandle: i32, // BOOL
lpTimerName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc OpenWaitableTimerW(
dwDesiredAccess: uint32, # SYNCHRONIZATION_ACCESS_RIGHTS
bInheritHandle: int32, # BOOL
lpTimerName: WideCString # LPCWSTR
): pointer {.importc: "OpenWaitableTimerW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "kernel32");
extern(Windows)
void* OpenWaitableTimerW(
uint dwDesiredAccess, // SYNCHRONIZATION_ACCESS_RIGHTS
int bInheritHandle, // BOOL
const(wchar)* lpTimerName // LPCWSTR
);ccall((:OpenWaitableTimerW, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
(UInt32, Int32, Cwstring),
dwDesiredAccess, bInheritHandle, lpTimerName)
# dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> UInt32
# bInheritHandle : BOOL -> Int32
# lpTimerName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
void* OpenWaitableTimerW(
uint32_t dwDesiredAccess,
int32_t bInheritHandle,
const uint16_t* lpTimerName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.OpenWaitableTimerW(dwDesiredAccess, bInheritHandle, lpTimerName)
-- dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS
-- bInheritHandle : BOOL
-- lpTimerName : LPCWSTR
-- 構造体/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 OpenWaitableTimerW = lib.func('__stdcall', 'OpenWaitableTimerW', 'void *', ['uint32_t', 'int32_t', 'str16']);
// OpenWaitableTimerW(dwDesiredAccess, bInheritHandle, lpTimerName)
// dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> 'uint32_t'
// bInheritHandle : BOOL -> 'int32_t'
// lpTimerName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
OpenWaitableTimerW: { parameters: ["u32", "i32", "buffer"], result: "pointer" },
});
// lib.symbols.OpenWaitableTimerW(dwDesiredAccess, bInheritHandle, lpTimerName)
// dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> "u32"
// bInheritHandle : BOOL -> "i32"
// lpTimerName : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void* OpenWaitableTimerW(
uint32_t dwDesiredAccess,
int32_t bInheritHandle,
const uint16_t* lpTimerName);
C, "KERNEL32.dll");
// $ffi->OpenWaitableTimerW(dwDesiredAccess, bInheritHandle, lpTimerName);
// dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS
// bInheritHandle : BOOL
// lpTimerName : LPCWSTR
// 構造体/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 OpenWaitableTimerW(
int dwDesiredAccess, // SYNCHRONIZATION_ACCESS_RIGHTS
boolean bInheritHandle, // BOOL
WString lpTimerName // LPCWSTR
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("kernel32")]
lib LibKERNEL32
fun OpenWaitableTimerW = OpenWaitableTimerW(
dwDesiredAccess : UInt32, # SYNCHRONIZATION_ACCESS_RIGHTS
bInheritHandle : Int32, # BOOL
lpTimerName : UInt16* # LPCWSTR
) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef OpenWaitableTimerWNative = Pointer<Void> Function(Uint32, Int32, Pointer<Utf16>);
typedef OpenWaitableTimerWDart = Pointer<Void> Function(int, int, Pointer<Utf16>);
final OpenWaitableTimerW = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<OpenWaitableTimerWNative, OpenWaitableTimerWDart>('OpenWaitableTimerW');
// dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> Uint32
// bInheritHandle : BOOL -> Int32
// lpTimerName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function OpenWaitableTimerW(
dwDesiredAccess: DWORD; // SYNCHRONIZATION_ACCESS_RIGHTS
bInheritHandle: BOOL; // BOOL
lpTimerName: PWideChar // LPCWSTR
): THandle; stdcall;
external 'KERNEL32.dll' name 'OpenWaitableTimerW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "OpenWaitableTimerW"
c_OpenWaitableTimerW :: Word32 -> CInt -> CWString -> IO (Ptr ())
-- dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> Word32
-- bInheritHandle : BOOL -> CInt
-- lpTimerName : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let openwaitabletimerw =
foreign "OpenWaitableTimerW"
(uint32_t @-> int32_t @-> (ptr uint16_t) @-> returning (ptr void))
(* dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> uint32_t *)
(* bInheritHandle : BOOL -> int32_t *)
(* lpTimerName : LPCWSTR -> (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 ("OpenWaitableTimerW" open-waitable-timer-w :convention :stdcall) :pointer
(dw-desired-access :uint32) ; SYNCHRONIZATION_ACCESS_RIGHTS
(b-inherit-handle :int32) ; BOOL
(lp-timer-name (:string :encoding :utf-16le))) ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $OpenWaitableTimerW = Win32::API::More->new('KERNEL32',
'HANDLE OpenWaitableTimerW(DWORD dwDesiredAccess, BOOL bInheritHandle, LPCWSTR lpTimerName)');
# my $ret = $OpenWaitableTimerW->Call($dwDesiredAccess, $bInheritHandle, $lpTimerName);
# dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> DWORD
# bInheritHandle : BOOL -> BOOL
# lpTimerName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f OpenWaitableTimerA (ANSI版) — 既存の名前付き待機可能タイマーを開く(ANSI版)。
- f CancelWaitableTimer — 待機可能タイマーの設定を解除して無効化する。
- f CloseHandle — オープンされたオブジェクトハンドルを閉じる。
- f CreateProcessW — 新しいプロセスとそのプライマリスレッドを作成する(Unicode版)。
- f DuplicateHandle — オブジェクトハンドルの複製を作成する。
- f SetWaitableTimer — 発火時刻と周期を指定して待機可能タイマーを設定する。