ホーム › System.Threading › CreateSemaphoreW

CreateSemaphoreW

関数

名前付きまたは無名のセマフォを作成する(Unicode版)。

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

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

HANDLE CreateSemaphoreW(
    SECURITY_ATTRIBUTES* lpSemaphoreAttributes,   // optional
    INT lInitialCount,
    INT lMaximumCount,
    LPCWSTR 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	LPCWSTR	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

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値はセマフォオブジェクトへのハンドルです。名前付きセマフォオブジェクトが関数呼び出しの前に既に存在していた場合、関数は既存のオブジェクトへのハンドルを返し、 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 または 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  (Unicode / -W)
#include <windows.h>

HANDLE CreateSemaphoreW(
    SECURITY_ATTRIBUTES* lpSemaphoreAttributes,   // optional
    INT lInitialCount,
    INT lMaximumCount,
    LPCWSTR lpName   // optional
);

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

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

' lpSemaphoreAttributes : SECURITY_ATTRIBUTES* optional
' lInitialCount : INT
' lMaximumCount : INT
' lpName : LPCWSTR optional
Declare PtrSafe Function CreateSemaphoreW Lib "kernel32" ( _
    ByVal lpSemaphoreAttributes As LongPtr, _
    ByVal lInitialCount As Long, _
    ByVal lMaximumCount As Long, _
    ByVal lpName As LongPtr) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CreateSemaphoreW = Fiddle::Function.new(
  lib['CreateSemaphoreW'],
  [
    Fiddle::TYPE_VOIDP,  # lpSemaphoreAttributes : SECURITY_ATTRIBUTES* optional
    Fiddle::TYPE_INT,  # lInitialCount : INT
    Fiddle::TYPE_INT,  # lMaximumCount : INT
    Fiddle::TYPE_VOIDP,  # lpName : LPCWSTR optional
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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