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

GetUmsCompletionListEvent

関数
UMS完了リストに関連付けられたイベントハンドルを取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 7 以降

シグネチャ

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

BOOL GetUmsCompletionListEvent(
    void* UmsCompletionList,
    HANDLE* UmsCompletionEvent
);

パラメーター

名前方向説明
UmsCompletionListvoid*inUMS 完了リストへのポインター。このポインターは CreateUmsCompletionList 関数によって提供されます。
UmsCompletionEventHANDLE*inoutHANDLE 変数へのポインター。出力時、UmsCompletionEvent パラメーターには、指定した完了リストに関連付けられたイベントのハンドルが設定されます。

戻り値の型: BOOL

公式ドキュメント

指定したユーザーモードスケジューリング (UMS) 完了リストに関連付けられたイベントのハンドルを取得します。

戻り値

関数が成功した場合は、0 以外の値を返します。

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

解説(Remarks)

システムは、空の完了リストに項目をキューに入れると、UMS 完了リストイベントをシグナル状態にします。完了リストイベントのハンドルは、イベントへのハンドルを受け取る任意の待機関数で使用できます。イベントがシグナル状態になると、アプリケーションは通常 DequeueUmsCompletionListItems を呼び出して完了リストの内容を取得します。

イベントハンドルは、その完了リストが削除されるまで有効です。既に削除された、または削除処理中の完了リストを待機するためにイベントハンドルを使用しないでください。

ハンドルが不要になったら、CloseHandle 関数を使用してハンドルを閉じてください。

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

各言語での呼び出し定義

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

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

GetUmsCompletionListEvent = ctypes.windll.kernel32.GetUmsCompletionListEvent
GetUmsCompletionListEvent.restype = wintypes.BOOL
GetUmsCompletionListEvent.argtypes = [
    ctypes.POINTER(None),  # UmsCompletionList : void*
    ctypes.c_void_p,  # UmsCompletionEvent : HANDLE* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetUmsCompletionListEvent = Fiddle::Function.new(
  lib['GetUmsCompletionListEvent'],
  [
    Fiddle::TYPE_VOIDP,  # UmsCompletionList : void*
    Fiddle::TYPE_VOIDP,  # UmsCompletionEvent : HANDLE* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetUmsCompletionListEvent(
        UmsCompletionList: *mut (),  // void*
        UmsCompletionEvent: *mut *mut core::ffi::c_void  // HANDLE* in/out
    ) -> 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 GetUmsCompletionListEvent(IntPtr UmsCompletionList, IntPtr UmsCompletionEvent);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetUmsCompletionListEvent' -Namespace Win32 -PassThru
# $api::GetUmsCompletionListEvent(UmsCompletionList, UmsCompletionEvent)
#uselib "KERNEL32.dll"
#func global GetUmsCompletionListEvent "GetUmsCompletionListEvent" sptr, sptr
; GetUmsCompletionListEvent UmsCompletionList, UmsCompletionEvent   ; 戻り値は stat
; UmsCompletionList : void* -> "sptr"
; UmsCompletionEvent : HANDLE* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global GetUmsCompletionListEvent "GetUmsCompletionListEvent" sptr, sptr
; res = GetUmsCompletionListEvent(UmsCompletionList, UmsCompletionEvent)
; UmsCompletionList : void* -> "sptr"
; UmsCompletionEvent : HANDLE* in/out -> "sptr"
; BOOL GetUmsCompletionListEvent(void* UmsCompletionList, HANDLE* UmsCompletionEvent)
#uselib "KERNEL32.dll"
#cfunc global GetUmsCompletionListEvent "GetUmsCompletionListEvent" intptr, intptr
; res = GetUmsCompletionListEvent(UmsCompletionList, UmsCompletionEvent)
; UmsCompletionList : void* -> "intptr"
; UmsCompletionEvent : HANDLE* in/out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetUmsCompletionListEvent = kernel32.NewProc("GetUmsCompletionListEvent")
)

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

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

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

foreign import stdcall safe "GetUmsCompletionListEvent"
  c_GetUmsCompletionListEvent :: Ptr () -> Ptr () -> IO CInt
-- UmsCompletionList : void* -> Ptr ()
-- UmsCompletionEvent : HANDLE* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("GetUmsCompletionListEvent" get-ums-completion-list-event :convention :stdcall) :int32
  (ums-completion-list :pointer)   ; void*
  (ums-completion-event :pointer))   ; HANDLE* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetUmsCompletionListEvent = Win32::API::More->new('KERNEL32',
    'BOOL GetUmsCompletionListEvent(LPVOID UmsCompletionList, HANDLE UmsCompletionEvent)');
# my $ret = $GetUmsCompletionListEvent->Call($UmsCompletionList, $UmsCompletionEvent);
# UmsCompletionList : void* -> LPVOID
# UmsCompletionEvent : HANDLE* in/out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目