ホーム › System.Threading › ReleaseSemaphore

ReleaseSemaphore

関数

セマフォのカウントを指定数だけ増加させて解放する。

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

シグネチャ

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

BOOL ReleaseSemaphore(
    HANDLE hSemaphore,
    INT lReleaseCount,
    INT* lpPreviousCount   // optional
);

パラメーター

名前	型	方向	説明
hSemaphore	HANDLE	in	セマフォオブジェクトへのハンドル。 CreateSemaphore 関数または OpenSemaphore 関数がこのハンドルを返します。このハンドルには SEMAPHORE_MODIFY_STATE アクセス権が必要です。詳細については、 Synchronization Object Security and Access Rights を参照してください。
lReleaseCount	INT	in	セマフォオブジェクトの現在のカウントを増加させる量。値は 0 より大きくなければなりません。指定した量によってセマフォのカウントが、セマフォ作成時に指定された最大カウントを超えてしまう場合、カウントは変更されず、関数は FALSE を返します。
lpPreviousCount	INT*	outoptional	セマフォの以前のカウントを受け取る変数へのポインター。以前のカウントが不要な場合、このパラメーターは NULL にできます。

名前

型

方向

説明

hSemaphore

HANDLE

セマフォオブジェクトへのハンドル。 CreateSemaphore 関数または OpenSemaphore 関数がこのハンドルを返します。

このハンドルには SEMAPHORE_MODIFY_STATE アクセス権が必要です。詳細については、 Synchronization Object Security and Access Rights を参照してください。

lReleaseCount

INT

セマフォオブジェクトの現在のカウントを増加させる量。値は 0 より大きくなければなりません。指定した量によってセマフォのカウントが、セマフォ作成時に指定された最大カウントを超えてしまう場合、カウントは変更されず、関数は FALSE を返します。

lpPreviousCount

INT*

outoptional

セマフォの以前のカウントを受け取る変数へのポインター。以前のカウントが不要な場合、このパラメーターは NULL にできます。

戻り値の型: BOOL

公式ドキュメント

指定したセマフォオブジェクトのカウントを、指定した値だけ増加させます。

戻り値

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

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

解説(Remarks)

セマフォオブジェクトの状態は、カウントが 0 より大きいときはシグナル状態、カウントが 0 に等しいときは非シグナル状態になります。 CreateSemaphore 関数を呼び出すプロセスが、セマフォの初期カウントを指定します。セマフォのシグナル状態によって待機中のスレッドが解放されるたびに、セマフォのカウントは 1 ずつ減少します。

通常、アプリケーションはセマフォを使用して、リソースを使用するスレッド数を制限します。スレッドはリソースを使用する前に、待機関数のいずれかの呼び出しでセマフォハンドルを指定します。待機関数が戻ると、セマフォのカウントが 1 減少します。スレッドがリソースの使用を終えると、 ReleaseSemaphore を呼び出してセマフォのカウントを 1 増加させます。

ReleaseSemaphore のもう 1 つの用途は、アプリケーションの初期化中です。アプリケーションは初期カウント 0 でセマフォを作成できます。これによりセマフォの状態が非シグナル状態に設定され、すべてのスレッドが保護対象リソースへアクセスできないようにブロックされます。アプリケーションが初期化を完了すると、 ReleaseSemaphore を使用してカウントを最大値まで増加させ、保護対象リソースへの通常のアクセスを許可します。

lReleaseCount を負の数にできないため、 ReleaseSemaphore を使用してセマフォオブジェクトのカウントを減らすことはできません。アクセスを一時的に制限または減少させるには、セマフォのカウントが十分に減るまで、タイムアウト間隔を 0 にして WaitForSingleObject 関数を呼び出すループを作成します。(このループの実行中に、他のスレッドがカウントを減らす可能性があることに注意してください。) アクセスを復元するには、ループ内で WaitForSingleObject を呼び出した回数と等しいリリースカウントを指定して ReleaseSemaphore を呼び出します。

Examples

ReleaseSemaphore を使用する例については、 Using Semaphore Objects を参照してください。

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

各言語での呼び出し定義

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

BOOL ReleaseSemaphore(
    HANDLE hSemaphore,
    INT lReleaseCount,
    INT* lpPreviousCount   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ReleaseSemaphore(
    IntPtr hSemaphore,   // HANDLE
    int lReleaseCount,   // INT
    IntPtr lpPreviousCount   // INT* optional, out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReleaseSemaphore(
    hSemaphore As IntPtr,   ' HANDLE
    lReleaseCount As Integer,   ' INT
    lpPreviousCount As IntPtr   ' INT* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hSemaphore : HANDLE
' lReleaseCount : INT
' lpPreviousCount : INT* optional, out
Declare PtrSafe Function ReleaseSemaphore Lib "kernel32" ( _
    ByVal hSemaphore As LongPtr, _
    ByVal lReleaseCount As Long, _
    ByVal lpPreviousCount As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ReleaseSemaphore = ctypes.windll.kernel32.ReleaseSemaphore
ReleaseSemaphore.restype = wintypes.BOOL
ReleaseSemaphore.argtypes = [
    wintypes.HANDLE,  # hSemaphore : HANDLE
    ctypes.c_int,  # lReleaseCount : INT
    ctypes.POINTER(ctypes.c_int),  # lpPreviousCount : INT* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
ReleaseSemaphore = Fiddle::Function.new(
  lib['ReleaseSemaphore'],
  [
    Fiddle::TYPE_VOIDP,  # hSemaphore : HANDLE
    Fiddle::TYPE_INT,  # lReleaseCount : INT
    Fiddle::TYPE_VOIDP,  # lpPreviousCount : INT* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn ReleaseSemaphore(
        hSemaphore: *mut core::ffi::c_void,  // HANDLE
        lReleaseCount: i32,  // INT
        lpPreviousCount: *mut i32  // INT* optional, 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 ReleaseSemaphore(IntPtr hSemaphore, int lReleaseCount, IntPtr lpPreviousCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ReleaseSemaphore' -Namespace Win32 -PassThru
# $api::ReleaseSemaphore(hSemaphore, lReleaseCount, lpPreviousCount)

#uselib "KERNEL32.dll"
#func global ReleaseSemaphore "ReleaseSemaphore" sptr, sptr, sptr
; ReleaseSemaphore hSemaphore, lReleaseCount, varptr(lpPreviousCount)   ; 戻り値は stat
; hSemaphore : HANDLE -> "sptr"
; lReleaseCount : INT -> "sptr"
; lpPreviousCount : INT* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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