ホーム › System.Threading › EnterUmsSchedulingMode

EnterUmsSchedulingMode

関数

現在のスレッドをUMSスケジューラとして動作させる。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 7 以降

シグネチャ

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

BOOL EnterUmsSchedulingMode(
    UMS_SCHEDULER_STARTUP_INFO* SchedulerStartupInfo
);

パラメーター

名前	型	方向	説明
SchedulerStartupInfo	UMS_SCHEDULER_STARTUP_INFO*	in	スレッドの UMS 属性 (完了リストおよび UmsSchedulerProc エントリポイント関数を含む) を指定する UMS_SCHEDULER_STARTUP_INFO 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

呼び出し元のスレッドをユーザーモードスケジューリング (UMS) スケジューラスレッドに変換します。

戻り値

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

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

解説(Remarks)

アプリケーションの UMS スケジューラは、UMS スレッドの実行に使用される各プロセッサに対して 1 つの UMS スケジューラスレッドを作成します。スケジューラは通常、スケジューラスレッドのアフィニティを単一のプロセッサに設定し、そのプロセッサを当該スケジューラスレッド専用に実質的に予約します。スレッドアフィニティの詳細については、「Multiple Processors」を参照してください。

UMS スケジューラスレッドが作成されると、システムは EnterUmsSchedulingMode 関数の呼び出しで指定された UmsSchedulerProc エントリポイント関数を呼び出します。アプリケーションのスケジューラは、スケジューラスレッドのアプリケーション固有の初期化を完了し、実行する UMS ワーカースレッドを選択する責任を負います。

アプリケーションのスケジューラは、ワーカースレッドの UMS スレッドコンテキストを指定して ExecuteUmsThread を呼び出すことで、実行する UMS ワーカースレッドを選択します。ワーカースレッドは、UmsThreadYield を呼び出して制御を譲るか、ブロックするか、または終了するまで実行されます。その後、スケジューラスレッドは別のワーカースレッドを実行できる状態になります。

スケジューラスレッドは、すべてのワーカースレッドが自然な停止点に到達するまで、つまりすべてのワーカースレッドが制御を譲るか、ブロックするか、または終了するまで実行を継続する必要があります。

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

各言語での呼び出し定義

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

BOOL EnterUmsSchedulingMode(
    UMS_SCHEDULER_STARTUP_INFO* SchedulerStartupInfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool EnterUmsSchedulingMode(
    IntPtr SchedulerStartupInfo   // UMS_SCHEDULER_STARTUP_INFO*
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EnterUmsSchedulingMode(
    SchedulerStartupInfo As IntPtr   ' UMS_SCHEDULER_STARTUP_INFO*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' SchedulerStartupInfo : UMS_SCHEDULER_STARTUP_INFO*
Declare PtrSafe Function EnterUmsSchedulingMode Lib "kernel32" ( _
    ByVal SchedulerStartupInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EnterUmsSchedulingMode = ctypes.windll.kernel32.EnterUmsSchedulingMode
EnterUmsSchedulingMode.restype = wintypes.BOOL
EnterUmsSchedulingMode.argtypes = [
    ctypes.c_void_p,  # SchedulerStartupInfo : UMS_SCHEDULER_STARTUP_INFO*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
EnterUmsSchedulingMode = Fiddle::Function.new(
  lib['EnterUmsSchedulingMode'],
  [
    Fiddle::TYPE_VOIDP,  # SchedulerStartupInfo : UMS_SCHEDULER_STARTUP_INFO*
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn EnterUmsSchedulingMode(
        SchedulerStartupInfo: *mut UMS_SCHEDULER_STARTUP_INFO  // UMS_SCHEDULER_STARTUP_INFO*
    ) -> 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 EnterUmsSchedulingMode(IntPtr SchedulerStartupInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_EnterUmsSchedulingMode' -Namespace Win32 -PassThru
# $api::EnterUmsSchedulingMode(SchedulerStartupInfo)

#uselib "KERNEL32.dll"
#func global EnterUmsSchedulingMode "EnterUmsSchedulingMode" sptr
; EnterUmsSchedulingMode varptr(SchedulerStartupInfo)   ; 戻り値は stat
; SchedulerStartupInfo : UMS_SCHEDULER_STARTUP_INFO* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global EnterUmsSchedulingMode "EnterUmsSchedulingMode" var
; res = EnterUmsSchedulingMode(SchedulerStartupInfo)
; SchedulerStartupInfo : UMS_SCHEDULER_STARTUP_INFO* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global EnterUmsSchedulingMode "EnterUmsSchedulingMode" sptr
; res = EnterUmsSchedulingMode(varptr(SchedulerStartupInfo))
; SchedulerStartupInfo : UMS_SCHEDULER_STARTUP_INFO* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。