SafeWaitHandle Třída

Definice

Obor názvů:

Microsoft.Win32.SafeHandles

Sestavení:

System.Runtime.dll

Zdroj:

SafeWaitHandle.cs

Představuje třídu obálky pro popisovač čekání.

public ref class SafeWaitHandle sealed : Microsoft::Win32::SafeHandles::SafeHandleZeroOrMinusOneIsInvalid

public sealed class SafeWaitHandle : Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid

type SafeWaitHandle = class
    inherit SafeHandleZeroOrMinusOneIsInvalid

Public NotInheritable Class SafeWaitHandle
Inherits SafeHandleZeroOrMinusOneIsInvalid

Dědičnost

Object

CriticalFinalizerObject

SafeHandle

SafeHandleZeroOrMinusOneIsInvalid

SafeWaitHandle

Příklady

Následující příklad kódu ukazuje, jak použít zprostředkovatele komunikace k vytvoření mutex pomocí SafeWaitHandle třídy a nespravované CreateMutex funkce.

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);
    }
}

Imports Microsoft.Win32.SafeHandles
Imports System.Runtime.InteropServices

Class SafeHandlesExample


    Shared Sub Main()
        Dim uMutex As New UnmanagedMutex("YourCompanyName_SafeHandlesExample_MUTEX")

        Try

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


        Catch e As Exception
            Console.WriteLine(e)
        Finally
            uMutex.Release()
            Console.WriteLine("Mutex Released.")
        End Try

        Console.ReadLine()

    End Sub
End Class


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)> _
    Shared Function CreateMutex(ByVal lpMutexAttributes As IntPtr, ByVal bInitialOwner As Boolean, ByVal lpName As String) As SafeWaitHandle

    End Function



    ' Use interop to call the ReleaseMutex function.
    ' For more information about ReleaseMutex,
    ' see the unmanaged MSDN reference library.
    <DllImport("kernel32.dll")> _
    Public Shared Function ReleaseMutex(ByVal hMutex As SafeWaitHandle) As Boolean

    End Function



    Private handleValue As SafeWaitHandle = Nothing
    Private mutexAttrValue As IntPtr = IntPtr.Zero
    Private nameValue As String = Nothing


    Public Sub New(ByVal Name As String)
        nameValue = Name

    End Sub



    Public Sub Create()
        If nameValue Is Nothing AndAlso nameValue.Length = 0 Then
            Throw New ArgumentNullException("nameValue")
        End If

        handleValue = CreateMutex(mutexAttrValue, True, nameValue)

        ' If the handle is invalid,
        ' get the last Win32 error 
        ' and throw a Win32Exception.
        If handleValue.IsInvalid Then
            Marshal.ThrowExceptionForHR(Marshal.GetHRForLastWin32Error())
        End If

    End Sub


    Public ReadOnly Property Handle() As SafeWaitHandle
        Get
            ' If the handle is valid,
            ' return it.
            If Not handleValue.IsInvalid Then
                Return handleValue
            Else
                Return Nothing
            End If
        End Get
    End Property


    Public ReadOnly Property Name() As String
        Get
            Return nameValue
        End Get
    End Property



    Public Sub Release()
        ReleaseMutex(handleValue)

    End Sub
End Class

Poznámky

Třída SafeWaitHandle je používána System.Threading.WaitHandle třídou . Jedná se o obálku pro mutexy Win32 a události automatického a ručního resetování.

Důležité

Tento typ implementuje IDisposable rozhraní . Až s použitím typu skončíte, měli byste ho odstranit přímo nebo nepřímo. Chcete-li odstranit typ přímo, zavolejte jeho Dispose metodu try/catch v bloku. Pokud ho chcete odstranit nepřímo, použijte konstruktor jazyka, jako using je (v jazyce C#) nebo Using (v jazyce Visual Basic). Další informace najdete v části "Použití objektu, který implementuje IDisposable" v IDisposable tématu rozhraní.

Konstruktory

SafeWaitHandle()	Vytvoří .SafeWaitHandle
SafeWaitHandle(IntPtr, Boolean)	Inicializuje novou instanci SafeWaitHandle třídy .

Pole

handle

Určuje popisovač, který se má zabalit. (Zděděno od SafeHandle)

Vlastnosti

IsClosed	Získá hodnotu označující, zda je popisovač uzavřen. (Zděděno od SafeHandle)
IsInvalid	Získá hodnotu, která označuje, zda je popisovač neplatný. (Zděděno od SafeHandleZeroOrMinusOneIsInvalid)

Metody

Close()	Označí popisovač pro uvolnění a uvolnění prostředků. (Zděděno od SafeHandle)
DangerousAddRef(Boolean)	Ručně zvýší čítač odkazů na SafeHandle instance. (Zděděno od SafeHandle)
DangerousGetHandle()	Vrátí hodnotu handle pole. (Zděděno od SafeHandle)
DangerousRelease()	Ručně sníží čítač odkazů na SafeHandle instanci. (Zděděno od SafeHandle)
Dispose()	Uvolní všechny prostředky používané SafeHandle třídou . (Zděděno od SafeHandle)
Dispose(Boolean)	Uvolní nespravované prostředky používané SafeHandle třídou určující, zda se má provést normální operace odstranění. (Zděděno od SafeHandle)
Equals(Object)	Určí, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno od Object)
GetHashCode()	Slouží jako výchozí hashovací funkce. (Zděděno od Object)
GetType()	Type Získá z aktuální instance. (Zděděno od Object)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
ReleaseHandle()	Při přepsání v odvozené třídě spustí kód potřebný k uvolnění popisovače. (Zděděno od SafeHandle)
SetHandle(IntPtr)	Nastaví popisovač na zadaný předem existující popisovač. (Zděděno od SafeHandle)
SetHandleAsInvalid()	Označí úchyt jako již nepoužívané. (Zděděno od SafeHandle)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

• SafeHandleZeroOrMinusOneIsInvalid
• WaitHandle
• Mutex
• AutoResetEvent
• ManualResetEvent