ホーム › System.Threading › CreateSemaphoreA

CreateSemaphoreA

関数

名前付きセマフォオブジェクトを作成または取得する(ANSI版)。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

HANDLE CreateSemaphoreA(
    SECURITY_ATTRIBUTES* lpSemaphoreAttributes,   // optional
    INT lInitialCount,
    INT lMaximumCount,
    LPCSTR lpName   // optional
);

パラメーター

名前	型	方向	説明
lpSemaphoreAttributes	SECURITY_ATTRIBUTES*	inoptional	SECURITY_ATTRIBUTES 構造体へのポインターです。このパラメーターが NULL の場合、ハンドルは子プロセスに継承されません。構造体の lpSecurityDescriptor メンバーは、新しいセマフォのセキュリティ記述子を指定します。このパラメーターが NULL の場合、セマフォは既定のセキュリティ記述子を取得します。セマフォの既定のセキュリティ記述子内の ACL は、作成者のプライマリトークンまたは偽装トークンから取得されます。
lInitialCount	INT	in	セマフォオブジェクトの初期カウントです。この値は 0 以上 lMaximumCount 以下でなければなりません。セマフォの状態は、カウントが 0 より大きいときにシグナル状態となり、0 のときに非シグナル状態となります。待機関数がセマフォを待機していたスレッドを解放するたびに、カウントは 1 ずつ減少します。カウントは ReleaseSemaphore 関数を呼び出すことで、指定した量だけ増加します。
lMaximumCount	INT	in	セマフォオブジェクトの最大カウントです。この値は 0 より大きくなければなりません。
lpName	LPCSTR	inoptional	セマフォオブジェクトの名前です。名前は MAX_PATH 文字に制限されます。名前の比較では大文字と小文字が区別されます。 lpName が既存の名前付きセマフォオブジェクトの名前と一致する場合、この関数は SEMAPHORE_ALL_ACCESS アクセス権を要求します。この場合、lInitialCount および lMaximumCount パラメーターは、作成元プロセスによって既に設定されているため無視されます。lpSemaphoreAttributes パラメーターが NULL でない場合、それはハンドルを継承可能かどうかを決定しますが、そのセキュリティ記述子メンバーは無視されます。 lpName が NULL の場合、セマフォオブジェクトは名前なしで作成されます。 lpName が既存のイベント、ミューテックス、待機可能タイマー、ジョブ、またはファイルマッピングオブジェクトの名前と一致する場合、この関数は失敗し、 GetLastError 関数は ERROR_INVALID_HANDLE を返します。これは、これらのオブジェクトが同じ名前空間を共有するために発生します。名前には、グローバル名前空間またはセッション名前空間に明示的にオブジェクトを作成するために、"Global" または "Local" プレフィックスを付けることができます。名前の残りの部分には、円記号 (\) 以外の任意の文字を含めることができます。詳細については、 Kernel Object Namespaces を参照してください。ファストユーザー切り替えはターミナルサービスセッションを使用して実装されています。アプリケーションが複数のユーザーをサポートできるように、カーネルオブジェクト名はターミナルサービス向けに定められたガイドラインに従う必要があります。オブジェクトはプライベート名前空間に作成できます。詳細については、Object Namespaces を参照してください。

戻り値の型: HANDLE

公式ドキュメント

名前付きまたは名前なしのセマフォオブジェクトを作成または開きます。(CreateSemaphoreA)

戻り値

関数が成功した場合、戻り値はセマフォオブジェクトへのハンドルです。名前付きセマフォオブジェクトが関数呼び出しの前に既に存在していた場合、関数は既存のオブジェクトへのハンドルを返し、 GetLastError は ERROR_ALREADY_EXISTS を返します。

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

解説(Remarks)

CreateSemaphore が返すハンドルは SEMAPHORE_ALL_ACCESS アクセス権を持ち、呼び出し元にアクセスが許可されている限り、セマフォオブジェクトへのハンドルを必要とする任意の関数で使用できます。セマフォがサービスから、または別のユーザーを偽装しているスレッドから作成される場合、作成時にセマフォにセキュリティ記述子を適用するか、作成元プロセスの既定の DACL を変更してその既定のセキュリティ記述子を変更することができます。詳細については、 Synchronization Object Security and Access Rights を参照してください。

セマフォオブジェクトの状態は、カウントが 0 より大きいときにシグナル状態となり、カウントが 0 に等しいときに非シグナル状態となります。lInitialCount パラメーターは初期カウントを指定します。カウントは 0 未満になることも、lMaximumCount パラメーターで指定された値を超えることもありません。

呼び出し元プロセスの任意のスレッドは、いずれかの待機関数への呼び出しでセマフォオブジェクトハンドルを指定できます。単一オブジェクト待機関数は、指定されたオブジェクトの状態がシグナル状態になったときに戻ります。複数オブジェクト待機関数は、指定されたオブジェクトのいずれか 1 つがシグナル状態になったとき、またはすべてがシグナル状態になったときのいずれかで戻るように指示できます。待機関数が戻ると、待機中のスレッドは解放され、その実行を継続します。スレッドがセマフォオブジェクトに対する待機を完了するたびに、セマフォオブジェクトのカウントは 1 ずつ減少します。スレッドが終了すると、ReleaseSemaphore 関数を呼び出し、これによってセマフォオブジェクトのカウントが増加します。

複数のプロセスが同じセマフォオブジェクトのハンドルを持つことができ、プロセス間同期にオブジェクトを使用できます。次のオブジェクト共有メカニズムが利用できます。

CreateProcess 関数によって作成された子プロセスは、CreateSemaphore の lpSemaphoreAttributes パラメーターで継承が有効になっている場合、セマフォオブジェクトへのハンドルを継承できます。
プロセスは、別のプロセスで使用できる複製ハンドルを作成するために、 DuplicateHandle 関数への呼び出しでセマフォオブジェクトハンドルを指定できます。
プロセスは、 [OpenSemaphore](/windows/win32/api/synchapi/nf-synchapi-opensemaphorew) または CreateSemaphore 関数への呼び出しでセマフォオブジェクトの名前を指定できます。

ハンドルを閉じるには CloseHandle 関数を使用します。プロセスが終了すると、システムは自動的にハンドルを閉じます。セマフォオブジェクトは、その最後のハンドルが閉じられたときに破棄されます。

例

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

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

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

HANDLE CreateSemaphoreA(
    SECURITY_ATTRIBUTES* lpSemaphoreAttributes,   // optional
    INT lInitialCount,
    INT lMaximumCount,
    LPCSTR lpName   // optional
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateSemaphoreA(
    IntPtr lpSemaphoreAttributes,   // SECURITY_ATTRIBUTES* optional
    int lInitialCount,   // INT
    int lMaximumCount,   // INT
    [MarshalAs(UnmanagedType.LPStr)] string lpName   // LPCSTR optional
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateSemaphoreA(
    lpSemaphoreAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* optional
    lInitialCount As Integer,   ' INT
    lMaximumCount As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPStr)> lpName As String   ' LPCSTR optional
) As IntPtr
End Function

' lpSemaphoreAttributes : SECURITY_ATTRIBUTES* optional
' lInitialCount : INT
' lMaximumCount : INT
' lpName : LPCSTR optional
Declare PtrSafe Function CreateSemaphoreA Lib "kernel32" ( _
    ByVal lpSemaphoreAttributes As LongPtr, _
    ByVal lInitialCount As Long, _
    ByVal lMaximumCount As Long, _
    ByVal lpName As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CreateSemaphoreA = ctypes.windll.kernel32.CreateSemaphoreA
CreateSemaphoreA.restype = ctypes.c_void_p
CreateSemaphoreA.argtypes = [
    ctypes.c_void_p,  # lpSemaphoreAttributes : SECURITY_ATTRIBUTES* optional
    ctypes.c_int,  # lInitialCount : INT
    ctypes.c_int,  # lMaximumCount : INT
    wintypes.LPCSTR,  # lpName : LPCSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CreateSemaphoreA = Fiddle::Function.new(
  lib['CreateSemaphoreA'],
  [
    Fiddle::TYPE_VOIDP,  # lpSemaphoreAttributes : SECURITY_ATTRIBUTES* optional
    Fiddle::TYPE_INT,  # lInitialCount : INT
    Fiddle::TYPE_INT,  # lMaximumCount : INT
    Fiddle::TYPE_VOIDP,  # lpName : LPCSTR optional
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "kernel32")]
extern "system" {
    fn CreateSemaphoreA(
        lpSemaphoreAttributes: *mut SECURITY_ATTRIBUTES,  // SECURITY_ATTRIBUTES* optional
        lInitialCount: i32,  // INT
        lMaximumCount: i32,  // INT
        lpName: *const u8  // LPCSTR optional
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr CreateSemaphoreA(IntPtr lpSemaphoreAttributes, int lInitialCount, int lMaximumCount, [MarshalAs(UnmanagedType.LPStr)] string lpName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateSemaphoreA' -Namespace Win32 -PassThru
# $api::CreateSemaphoreA(lpSemaphoreAttributes, lInitialCount, lMaximumCount, lpName)

#uselib "KERNEL32.dll"
#func global CreateSemaphoreA "CreateSemaphoreA" sptr, sptr, sptr, sptr
; CreateSemaphoreA varptr(lpSemaphoreAttributes), lInitialCount, lMaximumCount, lpName   ; 戻り値は stat
; lpSemaphoreAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; lInitialCount : INT -> "sptr"
; lMaximumCount : INT -> "sptr"
; lpName : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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