ホーム › System.Threading › SleepConditionVariableCS

SleepConditionVariableCS

関数

クリティカルセクションを解放して条件変数を待機する。

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

シグネチャ

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

BOOL SleepConditionVariableCS(
    CONDITION_VARIABLE* ConditionVariable,
    CRITICAL_SECTION* CriticalSection,
    DWORD dwMilliseconds
);

パラメーター

名前	型	方向	説明
ConditionVariable	CONDITION_VARIABLE*	inout	条件変数へのポインターです。この変数は、InitializeConditionVariable を呼び出して動的に初期化するか、構造体変数に定数 CONDITION_VARIABLE_INIT を代入して静的に初期化しておく必要があります。
CriticalSection	CRITICAL_SECTION*	inout	クリティカルセクションオブジェクトへのポインターです。このクリティカルセクションは、SleepConditionVariableCS が呼び出される時点で、呼び出し元によってちょうど 1 回だけ取得（エンター）されている必要があります。
dwMilliseconds	DWORD	in	タイムアウト間隔（ミリ秒単位）です。タイムアウト間隔が経過すると、関数はクリティカルセクションを再取得して 0 を返します。dwMilliseconds が 0 の場合、関数は指定されたオブジェクトの状態をテストし、ただちに戻ります。dwMilliseconds が INFINITE の場合、関数のタイムアウト間隔は決して経過しません。詳細については「解説」を参照してください。

戻り値の型: BOOL

公式ドキュメント

指定された条件変数で待機（スリープ）し、指定されたクリティカルセクションをアトミックな操作として解放します。

戻り値

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

関数が失敗した場合、またはタイムアウト間隔が経過した場合、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。考えられるエラーコードには ERROR_TIMEOUT が含まれ、これは別のスレッドがスリープ中のスレッドを起こそうとする前にタイムアウト間隔が経過したことを示します。

解説(Remarks)

条件変数で待機（スリープ）しているスレッドは、指定されたタイムアウト間隔が経過する前に、WakeConditionVariable 関数または WakeAllConditionVariable 関数を使用して起こすことができます。この場合、スレッドはタイムアウト間隔が経過したときではなく、ウェイク処理が完了したときに起動します。スレッドが起動した後は、スリープ状態に入った際に解放したクリティカルセクションを再取得します。

条件変数は、スプリアスウェイクアップ（明示的なウェイクに関連付けられていない起動）やスティールンウェイクアップ（起こされたスレッドより先に別のスレッドが実行されてしまう状況）の影響を受けます。したがって、スリープ操作から戻った後は、述語（条件）を再チェックする必要があります（通常は while ループ内で行います）。

Examples

この関数を使用する例については、Using Condition Variables を参照してください。

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

各言語での呼び出し定義

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

BOOL SleepConditionVariableCS(
    CONDITION_VARIABLE* ConditionVariable,
    CRITICAL_SECTION* CriticalSection,
    DWORD dwMilliseconds
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SleepConditionVariableCS(
    IntPtr ConditionVariable,   // CONDITION_VARIABLE* in/out
    IntPtr CriticalSection,   // CRITICAL_SECTION* in/out
    uint dwMilliseconds   // DWORD
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SleepConditionVariableCS(
    ConditionVariable As IntPtr,   ' CONDITION_VARIABLE* in/out
    CriticalSection As IntPtr,   ' CRITICAL_SECTION* in/out
    dwMilliseconds As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' ConditionVariable : CONDITION_VARIABLE* in/out
' CriticalSection : CRITICAL_SECTION* in/out
' dwMilliseconds : DWORD
Declare PtrSafe Function SleepConditionVariableCS Lib "kernel32" ( _
    ByVal ConditionVariable As LongPtr, _
    ByVal CriticalSection As LongPtr, _
    ByVal dwMilliseconds As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SleepConditionVariableCS = ctypes.windll.kernel32.SleepConditionVariableCS
SleepConditionVariableCS.restype = wintypes.BOOL
SleepConditionVariableCS.argtypes = [
    ctypes.c_void_p,  # ConditionVariable : CONDITION_VARIABLE* in/out
    ctypes.c_void_p,  # CriticalSection : CRITICAL_SECTION* in/out
    wintypes.DWORD,  # dwMilliseconds : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SleepConditionVariableCS = Fiddle::Function.new(
  lib['SleepConditionVariableCS'],
  [
    Fiddle::TYPE_VOIDP,  # ConditionVariable : CONDITION_VARIABLE* in/out
    Fiddle::TYPE_VOIDP,  # CriticalSection : CRITICAL_SECTION* in/out
    -Fiddle::TYPE_INT,  # dwMilliseconds : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn SleepConditionVariableCS(
        ConditionVariable: *mut CONDITION_VARIABLE,  // CONDITION_VARIABLE* in/out
        CriticalSection: *mut CRITICAL_SECTION,  // CRITICAL_SECTION* in/out
        dwMilliseconds: u32  // DWORD
    ) -> 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 SleepConditionVariableCS(IntPtr ConditionVariable, IntPtr CriticalSection, uint dwMilliseconds);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SleepConditionVariableCS' -Namespace Win32 -PassThru
# $api::SleepConditionVariableCS(ConditionVariable, CriticalSection, dwMilliseconds)

#uselib "KERNEL32.dll"
#func global SleepConditionVariableCS "SleepConditionVariableCS" sptr, sptr, sptr
; SleepConditionVariableCS varptr(ConditionVariable), varptr(CriticalSection), dwMilliseconds   ; 戻り値は stat
; ConditionVariable : CONDITION_VARIABLE* in/out -> "sptr"
; CriticalSection : CRITICAL_SECTION* in/out -> "sptr"
; dwMilliseconds : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global SleepConditionVariableCS "SleepConditionVariableCS" var, var, int
; res = SleepConditionVariableCS(ConditionVariable, CriticalSection, dwMilliseconds)
; ConditionVariable : CONDITION_VARIABLE* in/out -> "var"
; CriticalSection : CRITICAL_SECTION* in/out -> "var"
; dwMilliseconds : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global SleepConditionVariableCS "SleepConditionVariableCS" sptr, sptr, int
; res = SleepConditionVariableCS(varptr(ConditionVariable), varptr(CriticalSection), dwMilliseconds)
; ConditionVariable : CONDITION_VARIABLE* in/out -> "sptr"
; CriticalSection : CRITICAL_SECTION* in/out -> "sptr"
; dwMilliseconds : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。