CreateMutexExW

関数

アクセス権とフラグを指定してミューテックスを作成する(Unicode版)。

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

シグネチャ

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

HANDLE CreateMutexExW(
    SECURITY_ATTRIBUTES* lpMutexAttributes,   // optional
    LPCWSTR lpName,   // optional
    DWORD dwFlags,
    DWORD dwDesiredAccess
);

パラメーター

名前

型

方向

説明

lpMutexAttributes

SECURITY_ATTRIBUTES*

inoptional

SECURITY_ATTRIBUTES 構造体へのポインターです。このパラメーターが NULL の場合、ミューテックスハンドルは子プロセスに継承されません。

構造体の lpSecurityDescriptor メンバーは、新しいミューテックスのセキュリティ記述子を指定します。lpMutexAttributes が NULL の場合、ミューテックスには既定のセキュリティ記述子が割り当てられます。ミューテックスの既定のセキュリティ記述子内の ACL は、作成者のプライマリトークンまたは偽装トークンに由来します。詳細については、Synchronization Object Security and Access Rights を参照してください。

lpName

LPCWSTR

inoptional

ミューテックスオブジェクトの名前です。名前は MAX_PATH 文字に制限されます。名前の比較では大文字と小文字が区別されます。

lpName が NULL の場合、ミューテックスオブジェクトは名前なしで作成されます。

lpName が既存のイベント、セマフォ、待機可能タイマー、ジョブ、またはファイルマッピングオブジェクトの名前と一致する場合、関数は失敗し、 GetLastError 関数は ERROR_INVALID_HANDLE を返します。これは、これらのオブジェクトが同じ名前空間を共有するためです。

名前には、グローバル名前空間またはセッション名前空間にオブジェクトを明示的に作成するために、"Global" または "Local" のプレフィックスを付けることができます。名前の残りの部分には、円記号 (\) を除く任意の文字を含めることができます。詳細については、 Kernel Object Namespaces を参照してください。ファストユーザー切り替えはターミナルサービスのセッションを使用して実装されています。アプリケーションが複数のユーザーをサポートできるように、カーネルオブジェクト名はターミナルサービスのガイドラインに従う必要があります。

オブジェクトはプライベート名前空間に作成できます。詳細については、Object Namespaces を参照してください。

dwFlags

DWORD

このパラメーターには 0 または次の値を指定できます。

値	意味
CREATE_MUTEX_INITIAL_OWNER 0x00000001	オブジェクトの作成者がミューテックスの初期所有者になります。

dwDesiredAccess

DWORD

ミューテックスオブジェクトのアクセスマスクです。アクセス権の一覧については、 Synchronization Object Security and Access Rights を参照してください。

戻り値の型: HANDLE

公式ドキュメント

名前付きまたは名前なしのミューテックスオブジェクトを作成または開き、そのオブジェクトへのハンドルを返します。 (Unicode)

戻り値

関数が成功した場合、戻り値は新しく作成されたミューテックスオブジェクトへのハンドルです。

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

ミューテックスが名前付きミューテックスであり、この関数呼び出しの前にオブジェクトが既に存在していた場合、戻り値は既存のオブジェクトへのハンドルとなり、GetLastError 関数は ERROR_ALREADY_EXISTS を返します。

解説(Remarks)

名前付きミューテックスを使用してアプリケーションを単一インスタンスに制限している場合、悪意のあるユーザーが先にこのミューテックスを作成し、アプリケーションの起動を妨げる可能性があります。この状況を防ぐには、ランダムな名前のミューテックスを作成し、その名前を承認されたユーザーのみが取得できるように保存します。あるいは、この目的でファイルを使用することもできます。アプリケーションをユーザーごとに 1 インスタンスに制限するには、ユーザーのプロファイルディレクトリにロックされたファイルを作成します。

呼び出し元プロセスの任意のスレッドは、待機関数のいずれかの呼び出しでミューテックスオブジェクトのハンドルを指定できます。単一オブジェクトの待機関数は、指定されたオブジェクトの状態がシグナル状態になると戻ります。複数オブジェクトの待機関数は、指定されたオブジェクトのいずれか 1 つがシグナル状態になったとき、またはすべてがシグナル状態になったときに戻るように指示できます。待機関数が戻ると、待機していたスレッドは解放されて実行を続行します。

ミューテックスオブジェクトの状態は、どのスレッドにも所有されていないときにシグナル状態になります。作成スレッドは、dwFlags パラメーターを使用してミューテックスの即時所有を要求できます。そうでない場合、スレッドは待機関数のいずれかを使用して所有権を要求する必要があります。ミューテックスの状態がシグナル状態になると、待機しているスレッドの 1 つに所有権が付与され、ミューテックスの状態が非シグナル状態に変わり、待機関数が戻ります。任意の時点でミューテックスを所有できるスレッドは 1 つだけです。所有スレッドは ReleaseMutex 関数を使用して所有権を解放します。

ミューテックスを所有するスレッドは、実行をブロックすることなく、繰り返しの待機関数呼び出しで同じミューテックスを指定できます。通常、同じミューテックスを繰り返し待機することはありませんが、このメカニズムにより、スレッドが既に所有しているミューテックスを待機している間に自身がデッドロックすることを防ぎます。ただし、所有権を解放するには、ミューテックスが待機を満たした回数だけ ReleaseMutex を呼び出す必要があります。

2 つ以上のプロセスが CreateMutex を呼び出して同じ名前付きミューテックスを作成できます。実際にミューテックスを作成するのは最初のプロセスであり、十分なアクセス権を持つ後続のプロセスは、既存のミューテックスへのハンドルを開くだけです。これにより、複数のプロセスが同じミューテックスのハンドルを取得できるようになり、作成プロセスが最初に起動されることをユーザーが保証する責任から解放されます。この手法を使用する場合は、CREATE_MUTEX_INITIAL_OWNER フラグを使用しないでください。使用すると、どのプロセスが初期所有権を持つかを確定することが困難になる可能性があります。

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

CreateProcess 関数によって作成された子プロセスは、 CreateMutex の lpMutexAttributes パラメーターで継承が有効になっている場合、ミューテックスオブジェクトへのハンドルを継承できます。このメカニズムは、名前付きと名前なしの両方のミューテックスで機能します。
プロセスは、DuplicateHandle 関数の呼び出しでミューテックスオブジェクトのハンドルを指定し、別のプロセスで使用できる複製ハンドルを作成できます。このメカニズムは、名前付きと名前なしの両方のミューテックスで機能します。
プロセスは、 [OpenMutex](./nf-synchapi-openmutexw.md) 関数または CreateMutex 関数の呼び出しで名前付きミューテックスを指定し、ミューテックスオブジェクトへのハンドルを取得できます。

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

メモ

synchapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして CreateMutexEx を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーが発生する可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateMutexExW(
    IntPtr lpMutexAttributes,   // SECURITY_ATTRIBUTES* optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpName,   // LPCWSTR optional
    uint dwFlags,   // DWORD
    uint dwDesiredAccess   // DWORD
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateMutexExW(
    lpMutexAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* optional
    <MarshalAs(UnmanagedType.LPWStr)> lpName As String,   ' LPCWSTR optional
    dwFlags As UInteger,   ' DWORD
    dwDesiredAccess As UInteger   ' DWORD
) As IntPtr
End Function

' lpMutexAttributes : SECURITY_ATTRIBUTES* optional
' lpName : LPCWSTR optional
' dwFlags : DWORD
' dwDesiredAccess : DWORD
Declare PtrSafe Function CreateMutexExW Lib "kernel32" ( _
    ByVal lpMutexAttributes As LongPtr, _
    ByVal lpName As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal dwDesiredAccess As Long) 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

CreateMutexExW = ctypes.windll.kernel32.CreateMutexExW
CreateMutexExW.restype = ctypes.c_void_p
CreateMutexExW.argtypes = [
    ctypes.c_void_p,  # lpMutexAttributes : SECURITY_ATTRIBUTES* optional
    wintypes.LPCWSTR,  # lpName : LPCWSTR optional
    wintypes.DWORD,  # dwFlags : DWORD
    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')
CreateMutexExW = Fiddle::Function.new(
  lib['CreateMutexExW'],
  [
    Fiddle::TYPE_VOIDP,  # lpMutexAttributes : SECURITY_ATTRIBUTES* optional
    Fiddle::TYPE_VOIDP,  # lpName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    -Fiddle::TYPE_INT,  # dwDesiredAccess : DWORD
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn CreateMutexExW(
        lpMutexAttributes: *mut SECURITY_ATTRIBUTES,  // SECURITY_ATTRIBUTES* optional
        lpName: *const u16,  // LPCWSTR optional
        dwFlags: u32,  // DWORD
        dwDesiredAccess: u32  // DWORD
    ) -> *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 CreateMutexExW(IntPtr lpMutexAttributes, [MarshalAs(UnmanagedType.LPWStr)] string lpName, uint dwFlags, uint dwDesiredAccess);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateMutexExW' -Namespace Win32 -PassThru
# $api::CreateMutexExW(lpMutexAttributes, lpName, dwFlags, dwDesiredAccess)

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

出力引数:

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