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

OpenWaitableTimerA

関数
既存の名前付き待機可能タイマーを開く(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

HANDLE OpenWaitableTimerA(
    DWORD dwDesiredAccess,
    BOOL bInheritHandle,
    LPCSTR lpTimerName
);

パラメーター

名前方向説明
dwDesiredAccessDWORDinタイマーオブジェクトへのアクセス権です。指定したオブジェクトのセキュリティ記述子が、呼び出し元プロセスに対して要求されたアクセスを許可していない場合、この関数は失敗します。アクセス権の一覧については、Synchronization Object Security and Access Rights を参照してください。
bInheritHandleBOOLinこの値が TRUE の場合、このプロセスによって作成されたプロセスはハンドルを継承します。それ以外の場合、プロセスはこのハンドルを継承しません。
lpTimerNameLPCSTRin

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

この関数はプライベート名前空間内のオブジェクトを開くことができます。詳細については、Object Namespaces を参照してください。

ターミナルサービス: 名前には "Global" または "Local" のプレフィックスを付けて、グローバル名前空間またはセッション名前空間内のオブジェクトを明示的に開くことができます。名前の残りの部分には、円記号 (\) を除く任意の文字を含めることができます。詳細については、Kernel Object Namespaces を参照してください。

注意 ファストユーザースイッチはターミナルサービスのセッションを使用して実装されています。最初にログオンするユーザーはセッション 0 を使用し、次にログオンするユーザーはセッション 1 を使用する、というように続きます。アプリケーションが複数のユーザーをサポートできるように、カーネルオブジェクト名はターミナルサービスのガイドラインに従う必要があります。

戻り値の型: HANDLE

公式ドキュメント

既存の名前付き待機可能タイマーオブジェクトを開きます。

戻り値

関数が成功すると、戻り値はタイマーオブジェクトへのハンドルになります。

関数が失敗すると、戻り値は NULL になります。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

OpenWaitableTimer 関数を使用すると、複数のプロセスが同じタイマーオブジェクトへのハンドルを開くことができます。この関数は、いずれかのプロセスが既に CreateWaitableTimer 関数を使用してタイマーを作成している場合にのみ成功します。呼び出し元プロセスは、dwDesiredAccess パラメーターで指定されたアクセスの制限に従って、wait functions など、タイマーオブジェクトへのハンドルを必要とする任意の関数で、返されたハンドルを使用できます。

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 OpenWaitableTimerA(
    DWORD dwDesiredAccess,
    BOOL bInheritHandle,
    LPCSTR lpTimerName
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr OpenWaitableTimerA(
    uint dwDesiredAccess,   // DWORD
    bool bInheritHandle,   // BOOL
    [MarshalAs(UnmanagedType.LPStr)] string lpTimerName   // LPCSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function OpenWaitableTimerA(
    dwDesiredAccess As UInteger,   ' DWORD
    bInheritHandle As Boolean,   ' BOOL
    <MarshalAs(UnmanagedType.LPStr)> lpTimerName As String   ' LPCSTR
) As IntPtr
End Function
' dwDesiredAccess : DWORD
' bInheritHandle : BOOL
' lpTimerName : LPCSTR
Declare PtrSafe Function OpenWaitableTimerA Lib "kernel32" ( _
    ByVal dwDesiredAccess As Long, _
    ByVal bInheritHandle 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

OpenWaitableTimerA = ctypes.windll.kernel32.OpenWaitableTimerA
OpenWaitableTimerA.restype = ctypes.c_void_p
OpenWaitableTimerA.argtypes = [
    wintypes.DWORD,  # dwDesiredAccess : DWORD
    wintypes.BOOL,  # bInheritHandle : BOOL
    wintypes.LPCSTR,  # lpTimerName : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
OpenWaitableTimerA = Fiddle::Function.new(
  lib['OpenWaitableTimerA'],
  [
    -Fiddle::TYPE_INT,  # dwDesiredAccess : DWORD
    Fiddle::TYPE_INT,  # bInheritHandle : BOOL
    Fiddle::TYPE_VOIDP,  # lpTimerName : LPCSTR
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn OpenWaitableTimerA(
        dwDesiredAccess: u32,  // DWORD
        bInheritHandle: i32,  // BOOL
        lpTimerName: *const u8  // LPCSTR
    ) -> *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 OpenWaitableTimerA(uint dwDesiredAccess, bool bInheritHandle, [MarshalAs(UnmanagedType.LPStr)] string lpTimerName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_OpenWaitableTimerA' -Namespace Win32 -PassThru
# $api::OpenWaitableTimerA(dwDesiredAccess, bInheritHandle, lpTimerName)
#uselib "KERNEL32.dll"
#func global OpenWaitableTimerA "OpenWaitableTimerA" sptr, sptr, sptr
; OpenWaitableTimerA dwDesiredAccess, bInheritHandle, lpTimerName   ; 戻り値は stat
; dwDesiredAccess : DWORD -> "sptr"
; bInheritHandle : BOOL -> "sptr"
; lpTimerName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global OpenWaitableTimerA "OpenWaitableTimerA" int, int, str
; res = OpenWaitableTimerA(dwDesiredAccess, bInheritHandle, lpTimerName)
; dwDesiredAccess : DWORD -> "int"
; bInheritHandle : BOOL -> "int"
; lpTimerName : LPCSTR -> "str"
; HANDLE OpenWaitableTimerA(DWORD dwDesiredAccess, BOOL bInheritHandle, LPCSTR lpTimerName)
#uselib "KERNEL32.dll"
#cfunc global OpenWaitableTimerA "OpenWaitableTimerA" int, int, str
; res = OpenWaitableTimerA(dwDesiredAccess, bInheritHandle, lpTimerName)
; dwDesiredAccess : DWORD -> "int"
; bInheritHandle : BOOL -> "int"
; lpTimerName : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procOpenWaitableTimerA = kernel32.NewProc("OpenWaitableTimerA")
)

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

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

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

foreign import stdcall safe "OpenWaitableTimerA"
  c_OpenWaitableTimerA :: Word32 -> CInt -> CString -> IO (Ptr ())
-- dwDesiredAccess : DWORD -> Word32
-- bInheritHandle : BOOL -> CInt
-- lpTimerName : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("OpenWaitableTimerA" open-waitable-timer-a :convention :stdcall) :pointer
  (dw-desired-access :uint32)   ; DWORD
  (b-inherit-handle :int32)   ; BOOL
  (lp-timer-name :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenWaitableTimerA = Win32::API::More->new('KERNEL32',
    'HANDLE OpenWaitableTimerA(DWORD dwDesiredAccess, BOOL bInheritHandle, LPCSTR lpTimerName)');
# my $ret = $OpenWaitableTimerA->Call($dwDesiredAccess, $bInheritHandle, $lpTimerName);
# dwDesiredAccess : DWORD -> DWORD
# bInheritHandle : BOOL -> BOOL
# lpTimerName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目