ホーム › System.Threading › SleepConditionVariableSRW

SleepConditionVariableSRW

関数

SRWロックを解放して条件変数を待機する。

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

シグネチャ

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

BOOL SleepConditionVariableSRW(
    CONDITION_VARIABLE* ConditionVariable,
    SRWLOCK* SRWLock,
    DWORD dwMilliseconds,
    DWORD Flags
);

パラメーター

名前	型	方向	説明
ConditionVariable	CONDITION_VARIABLE*	inout	条件変数へのポインター。この変数は、InitializeConditionVariable を呼び出して(構造体を動的に初期化する)か、定数 CONDITION_VARIABLE_INIT を構造体変数に代入して(構造体を静的に初期化する)、初期化されている必要があります。
SRWLock	SRWLOCK*	inout	ロックへのポインター。このロックは、Flags パラメーターで指定された方法で保持されている必要があります。
dwMilliseconds	DWORD	in	タイムアウト間隔(ミリ秒単位)。この間隔が経過すると、関数は戻ります。dwMilliseconds が 0 の場合、関数は指定されたオブジェクトの状態をテストして直ちに戻ります。dwMilliseconds が INFINITE の場合、関数のタイムアウト間隔は決して経過しません。
Flags	DWORD	in	このパラメーターが CONDITION_VARIABLE_LOCKMODE_SHARED の場合、SRW ロックは共有モードになります。それ以外の場合、ロックは排他モードになります。

戻り値の型: BOOL

公式ドキュメント

指定された条件変数でスリープし、アトミック操作として指定されたロックを解放します。

戻り値

関数が成功すると、戻り値は 0 以外になります。

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

タイムアウトが経過した場合、関数は FALSE を返し、GetLastError は ERROR_TIMEOUT を返します。

解説(Remarks)

この関数が呼び出されたときにロックがロック解除されている場合、関数の動作は未定義です。

スレッドは、WakeConditionVariable または WakeAllConditionVariable 関数を使用して起こすことができます。スレッドが起こされた後、スレッドはスリープ状態に入ったときに解放したロックを再取得します。

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

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

各言語での呼び出し定義

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

BOOL SleepConditionVariableSRW(
    CONDITION_VARIABLE* ConditionVariable,
    SRWLOCK* SRWLock,
    DWORD dwMilliseconds,
    DWORD Flags
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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