RTMutex.OpenExisting Method

RTMutex OpenExisting Method

IntervalZero RTX Managed Code

Opens an existing named mutex.

Namespace: RTX.Threading
Assembly: IntervalZero.RTX (in IntervalZero.RTX.dll) Version: 12.0.0.0 (12.0.0.0)

Syntax

public static RTMutex OpenExisting(
	string name
)

public static RTMutex OpenExisting(
	string name
)

Public Shared Function OpenExisting ( 
	name As String
) As RTMutex

Public Shared Function OpenExisting ( 
	name As String
) As RTMutex

public:
static RTMutex^ OpenExisting(
	String^ name
)

public:
static RTMutex^ OpenExisting(
	String^ name
)

Parameters

name: Type: System String
The name of a system-wide named mutex object.

Return Value

Type: RTMutex
A RTMutex object that represents a named system mutex.

Exceptions

Exception	Condition
System ArgumentException	name is a zero-length string. -or- name is longer than 260 characters.
System ArgumentNullException	name is a null reference (Nothing in Visual Basic).
System.Threading WaitHandleCannotBeOpenedException	The named mutex does not exist.

Remarks

The OpenExisting method attempts to open an existing named mutex. If the system mutex does not exist, this method throws an exception instead of creating the system object. Two calls to this method with the same value for name do not necessarily return the same RTMutex object, even though they represent the same named system mutex.