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

DequeueUmsCompletionListItems

関数
UMS完了リストから実行可能なスレッド項目を取り出す。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 7 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL DequeueUmsCompletionListItems(
    void* UmsCompletionList,
    DWORD WaitTimeOut,
    void** UmsThreadList
);

パラメーター

名前型方向説明
UmsCompletionListvoid*inワーカー スレッドを取得する対象の完了リストへのポインターです。
WaitTimeOutDWORDin

取得操作のタイムアウト間隔をミリ秒単位で指定します。完了リストにワーカー スレッドがキューイングされていない場合でも、この間隔が経過すると関数は戻ります。

WaitTimeOut パラメーターが 0 の場合、ワーカー スレッドが利用可能になるのを待たずに、完了リストに利用可能なワーカー スレッドがあるかどうかを確認します。WaitTimeOut パラメーターが INFINITE の場合、関数のタイムアウト間隔は経過しません。ただし、1 つ以上のワーカー スレッドが利用可能になるまで関数がブロックされるため、これは推奨されません。

UmsThreadListvoid**out

UMS_CONTEXT 変数へのポインターです。出力時、このパラメーターは UMS スレッド コンテキストのリスト内の最初の UMS スレッド コンテキストへのポインターを受け取ります。

WaitTimeOut パラメーターで指定されたタイムアウト前に利用可能なワーカー スレッドがない場合、このパラメーターは NULL に設定されます。

戻り値の型: BOOL

公式ドキュメント

指定された UMS 完了リストからユーザーモード スケジューリング (UMS) ワーカー スレッドを取得します。

戻り値

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

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

戻り値 説明
ERROR_TIMEOUT
 指定されたタイムアウト間隔が経過する前に、利用可能になったスレッドがありませんでした。
ERROR_NOT_SUPPORTED
 UMS はサポートされていません。

解説(Remarks)

システムは、ワーカー スレッドが作成されたとき、または以前にブロックされていたワーカー スレッドのブロックが解除されたときに、UMS ワーカー スレッドを完了リストにキューイングします。DequeueUmsCompletionListItems 関数は、指定された完了リスト内のすべてのスレッド コンテキストのリストへのポインターを取得します。GetNextUmsListItem 関数を使用すると、UMS スレッド コンテキストをリストから取り出して、スケジューラー自身の実行可能スレッド キューに移すことができます。スケジューラーは、アプリケーションが選択した優先順位に基づいて実行するスレッドを選択する役割を担います。

DequeueUmsCompletionListItems によって提供されるリストから UMS スレッドを直接実行したり、リストが完全に空になる前にリストから実行可能スレッド キューに移されたスレッドを実行したりしないでください。これはアプリケーションで予測できない動作を引き起こす可能性があります。

複数の呼び出し元が共有完了リストからスレッドを取得しようとした場合、最初の呼び出し元だけがスレッドを取得します。後続の呼び出し元に対しては、DequeueUmsCompletionListItems 関数は成功を返しますが、UmsThreadList パラメーターは NULL に設定されます。

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

各言語での呼び出し定義

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

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procDequeueUmsCompletionListItems = kernel32.NewProc("DequeueUmsCompletionListItems")
)

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

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

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

foreign import stdcall safe "DequeueUmsCompletionListItems"
  c_DequeueUmsCompletionListItems :: Ptr () -> Word32 -> Ptr () -> IO CInt
-- UmsCompletionList : void* -> Ptr ()
-- WaitTimeOut : DWORD -> Word32
-- UmsThreadList : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dequeueumscompletionlistitems =
  foreign "DequeueUmsCompletionListItems"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* UmsCompletionList : void* -> (ptr void) *)
(* WaitTimeOut : DWORD -> uint32_t *)
(* UmsThreadList : void** 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 ("DequeueUmsCompletionListItems" dequeue-ums-completion-list-items :convention :stdcall) :int32
  (ums-completion-list :pointer)   ; void*
  (wait-time-out :uint32)   ; DWORD
  (ums-thread-list :pointer))   ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DequeueUmsCompletionListItems = Win32::API::More->new('KERNEL32',
    'BOOL DequeueUmsCompletionListItems(LPVOID UmsCompletionList, DWORD WaitTimeOut, LPVOID UmsThreadList)');
# my $ret = $DequeueUmsCompletionListItems->Call($UmsCompletionList, $WaitTimeOut, $UmsThreadList);
# UmsCompletionList : void* -> LPVOID
# WaitTimeOut : DWORD -> DWORD
# UmsThreadList : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目