Mutex::TryOpenExisting Method (String^, Mutex^%)
Opens the specified named mutex, if it already exists, and returns a value that indicates whether the operation succeeded.
Assembly: mscorlib (in mscorlib.dll)
public: [SecurityCriticalAttribute] static bool TryOpenExisting( String^ name, [OutAttribute] Mutex^% result )
Parameters
- name
-
Type:
System::String^
The name of the system mutex to open.
- result
-
Type:
System.Threading::Mutex^%
When this method returns, contains a Mutex object that represents the named mutex if the call succeeded, or null if the call failed. This parameter is treated as uninitialized.
Return Value
Type: System::Booleantrue if the named mutex was opened successfully; otherwise, false.
| Exception | Condition |
|---|---|
| ArgumentException | name is an empty string. -or- name is longer than 260 characters. |
| ArgumentNullException | name is null. |
| IOException | A Win32 error occurred. |
| UnauthorizedAccessException | The named mutex exists, but the user does not have the security access required to use it. |
If the named mutex does not exist, this method does not create it. To create the system mutex when it does not already exist, use one of the Mutex constructors that has a name parameter.
If you are uncertain whether a named mutex exists, use this method overload instead of the OpenExisting(String^) method overload, which throws an exception if the mutex does not exist.
Multiple calls to this method that use the same value for name do not necessarily return the same Mutex object, even though the objects that are returned represent the same named system mutex.
This method overload is equivalent to calling the TryOpenExisting(String^, MutexRights, Mutex^%) method overload and specifying MutexRights::Synchronize and MutexRights::Modify rights, combined by using the bitwise OR operation. Specifying the MutexRights::Synchronize flag allows a thread to wait on the mutex, and specifying the MutexRights::Modify flag allows a thread to call the ReleaseMutex method.
This method does not request ownership of the mutex.
requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.
Available since 8
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1