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

CreateUmsCompletionList

関数
UMSスケジューラ用の完了リストを作成する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 7 以降

シグネチャ

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

BOOL CreateUmsCompletionList(
    void** UmsCompletionList
);

パラメーター

名前方向説明
UmsCompletionListvoid**outPUMS_COMPLETION_LIST 変数です。出力時に、このパラメーターは空の UMS 完了リストへのポインターを受け取ります。

戻り値の型: BOOL

公式ドキュメント

ユーザーモードスケジューリング (UMS) 完了リストを作成します。

戻り値

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

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

戻り値 説明
ERROR_NOT_ENOUGH_MEMORY
完了リストを作成するのに十分なメモリがありません。
ERROR_NOT_SUPPORTED
UMS はサポートされていません。

解説(Remarks)

完了リストは、スケジューラースレッドを作成するために EnterUmsSchedulingMode 関数が呼び出されたときに、UMS スケジューラースレッドに関連付けられます。システムは、新しく作成された UMS ワーカースレッドを完了リストにキューイングします。また、以前にブロックされていた UMS ワーカースレッドがブロック解除されたときにも、それらのスレッドを完了リストにキューイングします。

アプリケーションの UmsSchedulerProc エントリポイント関数が呼び出されると、アプリケーションのスケジューラーは DequeueUmsCompletionListItems を呼び出して完了リストから項目を取得する必要があります。

各完了リストには、関連付けられた完了リストイベントがあり、システムが空のリストに項目をキューイングするたびにシグナル状態になります。 指定された完了リストのイベントへのハンドルを取得するには、 GetUmsCompletionListEvent を使用します。

完了リストが不要になったら、 DeleteUmsCompletionList を使用してリストを解放します。 リストは解放する前に空でなければなりません。

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

各言語での呼び出し定義

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

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateUmsCompletionList = kernel32.NewProc("CreateUmsCompletionList")
)

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

extern "kernel32" fn CreateUmsCompletionList(
    UmsCompletionList: ?*anyopaque // void** out
) callconv(std.os.windows.WINAPI) i32;
proc CreateUmsCompletionList(
    UmsCompletionList: pointer  # void** out
): int32 {.importc: "CreateUmsCompletionList", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int CreateUmsCompletionList(
    void** UmsCompletionList   // void** out
);
ccall((:CreateUmsCompletionList, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid},),
      UmsCompletionList)
# UmsCompletionList : void** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CreateUmsCompletionList(
    void** UmsCompletionList);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CreateUmsCompletionList(UmsCompletionList)
-- UmsCompletionList : void** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CreateUmsCompletionList = lib.func('__stdcall', 'CreateUmsCompletionList', 'int32_t', ['void *']);
// CreateUmsCompletionList(UmsCompletionList)
// UmsCompletionList : void** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  CreateUmsCompletionList: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.CreateUmsCompletionList(UmsCompletionList)
// UmsCompletionList : void** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CreateUmsCompletionList(
    void** UmsCompletionList);
C, "KERNEL32.dll");
// $ffi->CreateUmsCompletionList(UmsCompletionList);
// UmsCompletionList : 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 CreateUmsCompletionList(
        Pointer UmsCompletionList   // void** out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun CreateUmsCompletionList = CreateUmsCompletionList(
    UmsCompletionList : 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 CreateUmsCompletionListNative = Int32 Function(Pointer<Void>);
typedef CreateUmsCompletionListDart = int Function(Pointer<Void>);
final CreateUmsCompletionList = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateUmsCompletionListNative, CreateUmsCompletionListDart>('CreateUmsCompletionList');
// UmsCompletionList : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateUmsCompletionList(
  UmsCompletionList: Pointer   // void** out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'CreateUmsCompletionList';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

公式の関連項目