MutexAcl.OpenExisting(String, MutexRights) Method

Definition

Namespace:

System.Threading

Assembly:

System.Threading.AccessControl.dll

Source:

MutexAcl.cs

Opens a specified named mutex, if it already exists, and applies the desired access rights.

public:
 static System::Threading::Mutex ^ OpenExisting(System::String ^ name, System::Security::AccessControl::MutexRights rights);

public static System.Threading.Mutex OpenExisting (string name, System.Security.AccessControl.MutexRights rights);

static member OpenExisting : string * System.Security.AccessControl.MutexRights -> System.Threading.Mutex

Public Shared Function OpenExisting (name As String, rights As MutexRights) As Mutex

Parameters

name

String

The name of the mutex to be opened. If it's prefixed by "Global", it refers to a machine-wide mutex. If it's prefixed by "Local", or doesn't have a prefix, it refers to a session-wide mutex. Both prefix and name are case-sensitive.

rights

MutexRights

The desired access rights to apply to the returned mutex.

Returns

Mutex

An existing named mutex.

Exceptions

ArgumentNullException

name is null.

ArgumentException

name is an empty string.

WaitHandleCannotBeOpenedException

The named mutex does not exist or is invalid.

DirectoryNotFoundException

The path was not found.

IOException

A Win32 error occurred.

UnauthorizedAccessException

The named mutex exists, but the user does not have the security access required to use it.