Win32 API 日本語リファレンス
ホーム › System.Threading › OpenMutexW

OpenMutexW

関数
既存の名前付きミューテックスを開く(Unicode版)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HANDLE OpenMutexW(
    SYNCHRONIZATION_ACCESS_RIGHTS dwDesiredAccess,
    BOOL bInheritHandle,
    LPCWSTR lpName
);

パラメーター

名前型方向説明
dwDesiredAccessSYNCHRONIZATION_ACCESS_RIGHTSinミューテックスオブジェクトへのアクセス権です。ミューテックスを使用するには SYNCHRONIZE アクセス権のみが必要です。ミューテックスのセキュリティを変更するには MUTEX_ALL_ACCESS を指定します。指定したオブジェクトのセキュリティ記述子が、呼び出し元プロセスに対して要求されたアクセスを許可していない場合、この関数は失敗します。アクセス権の一覧については、 Synchronization Object Security and Access Rights を参照してください。
bInheritHandleBOOLinこの値が TRUE の場合、このプロセスによって作成されたプロセスはハンドルを継承します。そうでない場合、プロセスはこのハンドルを継承しません。
lpNameLPCWSTRin

開くミューテックスの名前です。名前の比較では大文字と小文字が区別されます。

この関数はプライベート名前空間内のオブジェクトを開くことができます。詳細については、Object Namespaces を参照してください。

ターミナルサービス: 名前には、グローバル名前空間またはセッション名前空間のオブジェクトを明示的に開くために、"Global" または "Local" プレフィックスを付けることができます。名前の残りの部分には、バックスラッシュ文字 (\) を除く任意の文字を含めることができます。詳細については、 Kernel Object Namespaces を参照してください。

注 ユーザーの簡易切り替えはターミナルサービスセッションを使用して実装されています。最初にログオンしたユーザーはセッション 0 を使用し、次にログオンしたユーザーはセッション 1 を使用する、というように続きます。アプリケーションが複数のユーザーをサポートできるように、カーネルオブジェクト名はターミナルサービスのガイドラインに従う必要があります。

戻り値の型: HANDLE

公式ドキュメント

既存の名前付きミューテックスオブジェクトを開きます。

戻り値

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

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

名前付きミューテックスが存在しない場合、関数は失敗し、GetLastError は ERROR_FILE_NOT_FOUND を返します。

解説(Remarks)

OpenMutex 関数を使用すると、複数のプロセスが同じミューテックスオブジェクトのハンドルを開くことができます。この関数は、いずれかのプロセスが CreateMutex 関数を使用してミューテックスを既に作成している場合にのみ成功します。呼び出し元プロセスは、dwDesiredAccess パラメーターで指定したアクセスの制限に従って、 待機関数など、ミューテックスオブジェクトへのハンドルを必要とする任意の関数で、返されたハンドルを使用できます。

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

マルチスレッドアプリケーションが名前付きミューテックスオブジェクトの作成、オープン、クローズを繰り返し行う必要がある場合、競合状態が発生する可能性があります。このような場合は、OpenMutex ではなく CreateMutex を使用する方が適切です。CreateMutex はミューテックスが存在する場合はそれを開き、存在しない場合は作成するためです。

例

OpenMutex を使用する例については、 Using Named 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 OpenMutexW(
    SYNCHRONIZATION_ACCESS_RIGHTS dwDesiredAccess,
    BOOL bInheritHandle,
    LPCWSTR lpName
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr OpenMutexW(
    uint dwDesiredAccess,   // SYNCHRONIZATION_ACCESS_RIGHTS
    bool bInheritHandle,   // BOOL
    [MarshalAs(UnmanagedType.LPWStr)] string lpName   // LPCWSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function OpenMutexW(
    dwDesiredAccess As UInteger,   ' SYNCHRONIZATION_ACCESS_RIGHTS
    bInheritHandle As Boolean,   ' BOOL
    <MarshalAs(UnmanagedType.LPWStr)> lpName As String   ' LPCWSTR
) As IntPtr
End Function
' dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS
' bInheritHandle : BOOL
' lpName : LPCWSTR
Declare PtrSafe Function OpenMutexW Lib "kernel32" ( _
    ByVal dwDesiredAccess As Long, _
    ByVal bInheritHandle 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

OpenMutexW = ctypes.windll.kernel32.OpenMutexW
OpenMutexW.restype = ctypes.c_void_p
OpenMutexW.argtypes = [
    wintypes.DWORD,  # dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS
    wintypes.BOOL,  # bInheritHandle : BOOL
    wintypes.LPCWSTR,  # lpName : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
OpenMutexW = Fiddle::Function.new(
  lib['OpenMutexW'],
  [
    -Fiddle::TYPE_INT,  # dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS
    Fiddle::TYPE_INT,  # bInheritHandle : BOOL
    Fiddle::TYPE_VOIDP,  # lpName : LPCWSTR
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn OpenMutexW(
        dwDesiredAccess: u32,  // SYNCHRONIZATION_ACCESS_RIGHTS
        bInheritHandle: i32,  // BOOL
        lpName: *const u16  // LPCWSTR
    ) -> *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 OpenMutexW(uint dwDesiredAccess, bool bInheritHandle, [MarshalAs(UnmanagedType.LPWStr)] string lpName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_OpenMutexW' -Namespace Win32 -PassThru
# $api::OpenMutexW(dwDesiredAccess, bInheritHandle, lpName)
#uselib "KERNEL32.dll"
#func global OpenMutexW "OpenMutexW" wptr, wptr, wptr
; OpenMutexW dwDesiredAccess, bInheritHandle, lpName   ; 戻り値は stat
; dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> "wptr"
; bInheritHandle : BOOL -> "wptr"
; lpName : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global OpenMutexW "OpenMutexW" int, int, wstr
; res = OpenMutexW(dwDesiredAccess, bInheritHandle, lpName)
; dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> "int"
; bInheritHandle : BOOL -> "int"
; lpName : LPCWSTR -> "wstr"
; HANDLE OpenMutexW(SYNCHRONIZATION_ACCESS_RIGHTS dwDesiredAccess, BOOL bInheritHandle, LPCWSTR lpName)
#uselib "KERNEL32.dll"
#cfunc global OpenMutexW "OpenMutexW" int, int, wstr
; res = OpenMutexW(dwDesiredAccess, bInheritHandle, lpName)
; dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> "int"
; bInheritHandle : BOOL -> "int"
; lpName : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procOpenMutexW = kernel32.NewProc("OpenMutexW")
)

// dwDesiredAccess (SYNCHRONIZATION_ACCESS_RIGHTS), bInheritHandle (BOOL), lpName (LPCWSTR)
r1, _, err := procOpenMutexW.Call(
	uintptr(dwDesiredAccess),
	uintptr(bInheritHandle),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function OpenMutexW(
  dwDesiredAccess: DWORD;   // SYNCHRONIZATION_ACCESS_RIGHTS
  bInheritHandle: BOOL;   // BOOL
  lpName: PWideChar   // LPCWSTR
): THandle; stdcall;
  external 'KERNEL32.dll' name 'OpenMutexW';
result := DllCall("KERNEL32\OpenMutexW"
    , "UInt", dwDesiredAccess   ; SYNCHRONIZATION_ACCESS_RIGHTS
    , "Int", bInheritHandle   ; BOOL
    , "WStr", lpName   ; LPCWSTR
    , "Ptr")   ; return: HANDLE
●OpenMutexW(dwDesiredAccess, bInheritHandle, lpName) = DLL("KERNEL32.dll", "void* OpenMutexW(dword, bool, char*)")
# 呼び出し: OpenMutexW(dwDesiredAccess, bInheritHandle, lpName)
# dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> "dword"
# bInheritHandle : BOOL -> "bool"
# lpName : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn OpenMutexW(
    dwDesiredAccess: u32, // SYNCHRONIZATION_ACCESS_RIGHTS
    bInheritHandle: i32, // BOOL
    lpName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc OpenMutexW(
    dwDesiredAccess: uint32,  # SYNCHRONIZATION_ACCESS_RIGHTS
    bInheritHandle: int32,  # BOOL
    lpName: WideCString  # LPCWSTR
): pointer {.importc: "OpenMutexW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
void* OpenMutexW(
    uint dwDesiredAccess,   // SYNCHRONIZATION_ACCESS_RIGHTS
    int bInheritHandle,   // BOOL
    const(wchar)* lpName   // LPCWSTR
);
ccall((:OpenMutexW, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
      (UInt32, Int32, Cwstring),
      dwDesiredAccess, bInheritHandle, lpName)
# dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> UInt32
# bInheritHandle : BOOL -> Int32
# lpName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void* OpenMutexW(
    uint32_t dwDesiredAccess,
    int32_t bInheritHandle,
    const uint16_t* lpName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.OpenMutexW(dwDesiredAccess, bInheritHandle, lpName)
-- dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS
-- bInheritHandle : BOOL
-- lpName : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const OpenMutexW = lib.func('__stdcall', 'OpenMutexW', 'void *', ['uint32_t', 'int32_t', 'str16']);
// OpenMutexW(dwDesiredAccess, bInheritHandle, lpName)
// dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> 'uint32_t'
// bInheritHandle : BOOL -> 'int32_t'
// lpName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  OpenMutexW: { parameters: ["u32", "i32", "buffer"], result: "pointer" },
});
// lib.symbols.OpenMutexW(dwDesiredAccess, bInheritHandle, lpName)
// dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> "u32"
// bInheritHandle : BOOL -> "i32"
// lpName : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* OpenMutexW(
    uint32_t dwDesiredAccess,
    int32_t bInheritHandle,
    const uint16_t* lpName);
C, "KERNEL32.dll");
// $ffi->OpenMutexW(dwDesiredAccess, bInheritHandle, lpName);
// dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS
// bInheritHandle : BOOL
// lpName : LPCWSTR
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.UNICODE_OPTIONS);
    Pointer OpenMutexW(
        int dwDesiredAccess,   // SYNCHRONIZATION_ACCESS_RIGHTS
        boolean bInheritHandle,   // BOOL
        WString lpName   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun OpenMutexW = OpenMutexW(
    dwDesiredAccess : UInt32,   # SYNCHRONIZATION_ACCESS_RIGHTS
    bInheritHandle : Int32,   # BOOL
    lpName : UInt16*   # LPCWSTR
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef OpenMutexWNative = Pointer<Void> Function(Uint32, Int32, Pointer<Utf16>);
typedef OpenMutexWDart = Pointer<Void> Function(int, int, Pointer<Utf16>);
final OpenMutexW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<OpenMutexWNative, OpenMutexWDart>('OpenMutexW');
// dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> Uint32
// bInheritHandle : BOOL -> Int32
// lpName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OpenMutexW(
  dwDesiredAccess: DWORD;   // SYNCHRONIZATION_ACCESS_RIGHTS
  bInheritHandle: BOOL;   // BOOL
  lpName: PWideChar   // LPCWSTR
): THandle; stdcall;
  external 'KERNEL32.dll' name 'OpenMutexW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OpenMutexW"
  c_OpenMutexW :: Word32 -> CInt -> CWString -> IO (Ptr ())
-- dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> Word32
-- bInheritHandle : BOOL -> CInt
-- lpName : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let openmutexw =
  foreign "OpenMutexW"
    (uint32_t @-> int32_t @-> (ptr uint16_t) @-> returning (ptr void))
(* dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> uint32_t *)
(* bInheritHandle : BOOL -> int32_t *)
(* lpName : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("OpenMutexW" open-mutex-w :convention :stdcall) :pointer
  (dw-desired-access :uint32)   ; SYNCHRONIZATION_ACCESS_RIGHTS
  (b-inherit-handle :int32)   ; BOOL
  (lp-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenMutexW = Win32::API::More->new('KERNEL32',
    'HANDLE OpenMutexW(DWORD dwDesiredAccess, BOOL bInheritHandle, LPCWSTR lpName)');
# my $ret = $OpenMutexW->Call($dwDesiredAccess, $bInheritHandle, $lpName);
# dwDesiredAccess : SYNCHRONIZATION_ACCESS_RIGHTS -> DWORD
# bInheritHandle : BOOL -> BOOL
# lpName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型