RTSemaphore.OpenExisting Method

RTSemaphore OpenExisting Method

IntervalZero RTX Managed Code

Opens an existing named semaphore.

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

Syntax

public static RTSemaphore OpenExisting(
	string name
)

public static RTSemaphore OpenExisting(
	string name
)

Public Shared Function OpenExisting ( 
	name As String
) As RTSemaphore

Public Shared Function OpenExisting ( 
	name As String
) As RTSemaphore

public:
static RTSemaphore^ OpenExisting(
	String^ name
)

public:
static RTSemaphore^ OpenExisting(
	String^ name
)

Parameters

name: Type: System String
The name of a system semaphore.

Return Value

Type: RTSemaphore
A Online

Semaphore object that represents a named system semaphore.

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 semaphore does not exist.

Remarks

The OpenExisting method attempts to open only existing named semaphores. If a system semaphore with the specified name does not exist, this method throws an exception instead of creating the system semaphore. It is possible to create multiple Online

Semaphore objects that represent the same named system semaphore. Two calls to this method with the same value for name do not necessarily return the same Online

Semaphore object, even though the objects returned both represent the same named system semaphore.