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

UnregisterWait

関数
登録済みの待機操作を解除する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL UnregisterWait(
    HANDLE WaitHandle
);

パラメーター

名前方向説明
WaitHandleHANDLEin待機ハンドル。このハンドルは RegisterWaitForSingleObject 関数によって返されます。

戻り値の型: BOOL

公式ドキュメント

RegisterWaitForSingleObject 関数によって発行された、登録済みの待機操作をキャンセルします。(UnregisterWait)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

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

解説(Remarks)

UnregisterWait が呼び出された時点でタイマーに関連付けられたコールバック関数が完了していない場合、UnregisterWait はそのコールバック関数に対する待機の登録を解除し、ERROR_IO_PENDING エラーコードで失敗します。このエラーコードは関数が失敗したことを示すものではなく、関数を再度呼び出す必要はありません。登録解除操作が失敗した場合にのみエラーコードを設定する必要があるコードでは、代わりに UnregisterWaitEx を呼び出してください。

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

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

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL UnregisterWait(
    HANDLE WaitHandle
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool UnregisterWait(
    IntPtr WaitHandle   // HANDLE
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function UnregisterWait(
    WaitHandle As IntPtr   ' HANDLE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' WaitHandle : HANDLE
Declare PtrSafe Function UnregisterWait Lib "kernel32" ( _
    ByVal WaitHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

UnregisterWait = ctypes.windll.kernel32.UnregisterWait
UnregisterWait.restype = wintypes.BOOL
UnregisterWait.argtypes = [
    wintypes.HANDLE,  # WaitHandle : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
UnregisterWait = Fiddle::Function.new(
  lib['UnregisterWait'],
  [
    Fiddle::TYPE_VOIDP,  # WaitHandle : HANDLE
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn UnregisterWait(
        WaitHandle: *mut core::ffi::c_void  // HANDLE
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool UnregisterWait(IntPtr WaitHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_UnregisterWait' -Namespace Win32 -PassThru
# $api::UnregisterWait(WaitHandle)
#uselib "KERNEL32.dll"
#func global UnregisterWait "UnregisterWait" sptr
; UnregisterWait WaitHandle   ; 戻り値は stat
; WaitHandle : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global UnregisterWait "UnregisterWait" sptr
; res = UnregisterWait(WaitHandle)
; WaitHandle : HANDLE -> "sptr"
; BOOL UnregisterWait(HANDLE WaitHandle)
#uselib "KERNEL32.dll"
#cfunc global UnregisterWait "UnregisterWait" intptr
; res = UnregisterWait(WaitHandle)
; WaitHandle : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procUnregisterWait = kernel32.NewProc("UnregisterWait")
)

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

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

typedef UnregisterWaitNative = Int32 Function(Pointer<Void>);
typedef UnregisterWaitDart = int Function(Pointer<Void>);
final UnregisterWait = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<UnregisterWaitNative, UnregisterWaitDart>('UnregisterWait');
// WaitHandle : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UnregisterWait(
  WaitHandle: THandle   // HANDLE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'UnregisterWait';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UnregisterWait"
  c_UnregisterWait :: Ptr () -> IO CInt
-- WaitHandle : HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let unregisterwait =
  foreign "UnregisterWait"
    ((ptr void) @-> returning int32_t)
(* WaitHandle : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("UnregisterWait" unregister-wait :convention :stdcall) :int32
  (wait-handle :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UnregisterWait = Win32::API::More->new('KERNEL32',
    'BOOL UnregisterWait(HANDLE WaitHandle)');
# my $ret = $UnregisterWait->Call($WaitHandle);
# WaitHandle : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目