ホーム › System.Threading › CreateSemaphoreExA

CreateSemaphoreExA

関数

アクセス権とフラグを指定してセマフォを作成する(ANSI版)。

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

シグネチャ

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

HANDLE CreateSemaphoreExA(
    SECURITY_ATTRIBUTES* lpSemaphoreAttributes,   // optional
    INT lInitialCount,
    INT lMaximumCount,
    LPCSTR lpName,   // optional
    DWORD dwFlags,   // optional
    DWORD dwDesiredAccess
);

パラメーター

名前	型	方向	説明
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	セマフォオブジェクトの名前を指定する null 終端文字列へのポインターです。名前は MAX_PATH 文字に制限されます。名前の比較は大文字と小文字を区別します。 lpName が既存の名前付きセマフォオブジェクトの名前と一致する場合、lInitialCount および lMaximumCount パラメーターは無視されます。これらは作成プロセスによって既に設定されているためです。lpSemaphoreAttributes パラメーターが NULL でない場合、それはハンドルが継承可能かどうかを決定します。 lpName が NULL の場合、セマフォオブジェクトは名前なしで作成されます。 lpName が既存のイベント、ミューテックス、待機可能タイマー、ジョブ、またはファイルマッピングオブジェクトの名前と一致する場合、関数は失敗し、 GetLastError 関数は ERROR_INVALID_HANDLE を返します。これは、これらのオブジェクトが同じ名前空間を共有するために発生します。名前には "Global" または "Local" プレフィックスを付けて、グローバル名前空間またはセッション名前空間に明示的にオブジェクトを作成できます。名前の残りの部分には、バックスラッシュ文字 (\) を除く任意の文字を含めることができます。詳細については、 Kernel Object Namespaces を参照してください。ファストユーザースイッチは、ターミナルサービスのセッションを使用して実装されています。アプリケーションが複数のユーザーをサポートできるよう、カーネルオブジェクト名はターミナルサービスのガイドラインに従う必要があります。オブジェクトはプライベート名前空間に作成できます。詳細については、Object Namespaces を参照してください。
dwFlags	DWORD	optional	このパラメーターは予約済みであり、0 でなければなりません。
dwDesiredAccess	DWORD	in	セマフォオブジェクトのアクセスマスクです。アクセス権の一覧については、 Synchronization Object Security and Access Rights を参照してください。

戻り値の型: HANDLE

公式ドキュメント

名前付きまたは名前なしのセマフォオブジェクトを作成または開き、そのオブジェクトへのハンドルを返します。(CreateSemaphoreExA)

戻り値

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

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

解説(Remarks)

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

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

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

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 CreateSemaphoreExA(
    SECURITY_ATTRIBUTES* lpSemaphoreAttributes,   // optional
    INT lInitialCount,
    INT lMaximumCount,
    LPCSTR lpName,   // optional
    DWORD dwFlags,   // optional
    DWORD dwDesiredAccess
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CreateSemaphoreExA = Fiddle::Function.new(
  lib['CreateSemaphoreExA'],
  [
    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_INT,  # dwFlags : DWORD optional
    -Fiddle::TYPE_INT,  # dwDesiredAccess : DWORD
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "kernel32")]
extern "system" {
    fn CreateSemaphoreExA(
        lpSemaphoreAttributes: *mut SECURITY_ATTRIBUTES,  // SECURITY_ATTRIBUTES* optional
        lInitialCount: i32,  // INT
        lMaximumCount: i32,  // INT
        lpName: *const u8,  // LPCSTR optional
        dwFlags: u32,  // DWORD optional
        dwDesiredAccess: u32  // DWORD
    ) -> *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 CreateSemaphoreExA(IntPtr lpSemaphoreAttributes, int lInitialCount, int lMaximumCount, [MarshalAs(UnmanagedType.LPStr)] string lpName, uint dwFlags, uint dwDesiredAccess);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateSemaphoreExA' -Namespace Win32 -PassThru
# $api::CreateSemaphoreExA(lpSemaphoreAttributes, lInitialCount, lMaximumCount, lpName, dwFlags, dwDesiredAccess)

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

出力引数:

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