SafeWaitHandle Class

 

Represents a wrapper class for a wait handle.

Namespace:   Microsoft.Win32.SafeHandles
Assembly:  mscorlib (in mscorlib.dll)


[SecurityCriticalAttribute]
public sealed class SafeWaitHandle : SafeHandleZeroOrMinusOneIsInvalid

NameDescription
System_CAPS_pubmethodSafeWaitHandle(IntPtr, Boolean)

Initializes a new instance of the SafeWaitHandle class.

NameDescription
System_CAPS_pubpropertyIsClosed

Gets a value indicating whether the handle is closed.(Inherited from SafeHandle.)

System_CAPS_pubpropertyIsInvalid

Gets a value that indicates whether the handle is invalid.(Inherited from SafeHandleZeroOrMinusOneIsInvalid.)

NameDescription
System_CAPS_pubmethodClose()

Marks the handle for releasing and freeing resources.(Inherited from SafeHandle.)

System_CAPS_pubmethodDangerousAddRef(Boolean)

Manually increments the reference counter on SafeHandle instances.(Inherited from SafeHandle.)

System_CAPS_pubmethodDangerousGetHandle()

Returns the value of the handle field.(Inherited from SafeHandle.)

System_CAPS_pubmethodDangerousRelease()

Manually decrements the reference counter on a SafeHandle instance.(Inherited from SafeHandle.)

System_CAPS_pubmethodDispose()

Releases all resources used by the SafeHandle class.(Inherited from SafeHandle.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodSetHandleAsInvalid()

Marks a handle as no longer used.(Inherited from SafeHandle.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

The SafeWaitHandle class is used by the System.Threading.WaitHandle class. It is a wrapper for Win32 mutexes and auto and manual reset events.

System_CAPS_importantImportant

This type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the “Using an Object that Implements IDisposable” section in the IDisposable interface topic.

The following code example demonstrates how to use interop to create a mutex using the SafeWaitHandle class and the unmanaged CreateMutex function.

using System;
using Microsoft.Win32.SafeHandles;
using System.Runtime.InteropServices;


class SafeHandlesExample
{

    static void Main()
    {
        UnmanagedMutex uMutex = new UnmanagedMutex("YourCompanyName_SafeHandlesExample_MUTEX");

        try
        {

            uMutex.Create();
            Console.WriteLine("Mutex created. Press Enter to release it.");
            Console.ReadLine();


        }
        catch (Exception e)
        {
            Console.WriteLine(e);
        }
        finally
        {
            uMutex.Release();
            Console.WriteLine("Mutex Released.");
        }

        Console.ReadLine();


    }
}

class UnmanagedMutex 
{


    // Use interop to call the CreateMutex function.
    // For more information about CreateMutex,
    // see the unmanaged MSDN reference library.
    [DllImport("kernel32.dll", CharSet=CharSet.Unicode)]
    static extern SafeWaitHandle CreateMutex(IntPtr lpMutexAttributes, bool bInitialOwner,
    string lpName);


    // Use interop to call the ReleaseMutex function.
    // For more information about ReleaseMutex,
    // see the unmanaged MSDN reference library.
    [DllImport("kernel32.dll")]
    public static extern bool ReleaseMutex(SafeWaitHandle hMutex);



    private SafeWaitHandle handleValue = null;
    private IntPtr mutexAttrValue = IntPtr.Zero;
    private string nameValue = null;

    public UnmanagedMutex(string Name)
    {
        nameValue = Name;
    }


    public void Create()
    {
        if (nameValue == null && nameValue.Length == 0)
        {
            throw new ArgumentNullException("nameValue");
        }

        handleValue = CreateMutex(mutexAttrValue,
                                        true, nameValue);

        // If the handle is invalid,
        // get the last Win32 error 
        // and throw a Win32Exception.
        if (handleValue.IsInvalid)
        {
            Marshal.ThrowExceptionForHR(Marshal.GetHRForLastWin32Error());
        }
    }

    public SafeWaitHandle Handle
    {
        get
        {
            // If the handle is valid,
            // return it.
            if (!handleValue.IsInvalid)
            {
                return handleValue;
            }
            else
            {
                return null;
            }
        }

    }

    public string Name
    {
        get
        {
            return nameValue;
        }

    }


    public void Release()
    {
        ReleaseMutex(handleValue);
    }

}

SecurityCriticalAttribute

requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: