SafeWaitHandle Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Stellt eine Wrapperklasse für ein Wartezeithandle dar.
public ref class SafeWaitHandle sealed : System::Runtime::InteropServices::SafeHandle
public ref class SafeWaitHandle sealed : Microsoft::Win32::SafeHandles::SafeHandleZeroOrMinusOneIsInvalid
[System.Security.SecurityCritical]
public sealed class SafeWaitHandle : System.Runtime.InteropServices.SafeHandle
public sealed class SafeWaitHandle : Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid
[System.Security.SecurityCritical]
public sealed class SafeWaitHandle : Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid
[<System.Security.SecurityCritical>]
type SafeWaitHandle = class
inherit SafeHandle
type SafeWaitHandle = class
inherit SafeHandleZeroOrMinusOneIsInvalid
[<System.Security.SecurityCritical>]
type SafeWaitHandle = class
inherit SafeHandleZeroOrMinusOneIsInvalid
Public NotInheritable Class SafeWaitHandle
Inherits SafeHandle
Public NotInheritable Class SafeWaitHandle
Inherits SafeHandleZeroOrMinusOneIsInvalid
- Vererbung
- Vererbung
- Attribute
Beispiele
Im folgenden Codebeispiel wird veranschaulicht, wie Sie mithilfe von Interop einen Mutex mithilfe der SafeWaitHandle Klasse und der nicht verwalteten CreateMutex Funktion erstellen.
using System;
using Microsoft.Win32.SafeHandles;
using System.Runtime.InteropServices;
class SafeHandlesExample
{
static void Main()
{
UnmanagedMutex uMutex = new("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.");
}
}
}
partial class UnmanagedMutex(string Name)
{
// Use interop to call the CreateMutex function.
[LibraryImport("kernel32.dll", EntryPoint = "CreateMutexW", StringMarshalling = StringMarshalling.Utf16)]
private static partial SafeWaitHandle CreateMutex(
IntPtr lpMutexAttributes,
[MarshalAs(UnmanagedType.Bool)] bool bInitialOwner,
string lpName
);
// Use interop to call the ReleaseMutex function.
// For more information about ReleaseMutex,
// see the unmanaged MSDN reference library.
[LibraryImport("kernel32.dll")]
[return: MarshalAs(UnmanagedType.Bool)]
public static partial bool ReleaseMutex(SafeWaitHandle hMutex);
private SafeWaitHandle _handleValue = null;
private readonly IntPtr _mutexAttrValue = IntPtr.Zero;
private string nameValue = Name;
public void Create()
{
ArgumentException.ThrowIfNullOrEmpty(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 (!_handleValue.IsInvalid)
{
return _handleValue;
}
else
{
return null;
}
}
}
public string Name => 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
Hinweise
Die SafeWaitHandle Klasse wird von der System.Threading.WaitHandle Klasse verwendet. Es ist ein Wrapper für Win32 Mutexes und automatische und manuelle Zurücksetzungsereignisse.
Important
Dieser Typ implementiert die IDisposable Schnittstelle. Nach Abschluss der Verwendung sollten Sie den Typ entweder direkt oder indirekt löschen. Rufen Sie die Methode Dispose in einem try/catch-Block auf, um den Typ direkt zu entsorgen. Verwenden Sie zum indirekten Löschen ein Sprachkonstrukt wie using (in C#) oder Using (in Visual Basic).
Konstruktoren
| Name | Beschreibung |
|---|---|
| SafeWaitHandle() |
Erstellt eine SafeWaitHandle. |
| SafeWaitHandle(IntPtr, Boolean) |
Initialisiert eine neue Instanz der SafeWaitHandle-Klasse. |
Felder
| Name | Beschreibung |
|---|---|
| handle |
Gibt das Handle an, das umschlossen werden soll. (Geerbt von SafeHandle) |
Eigenschaften
| Name | Beschreibung |
|---|---|
| IsClosed |
Ruft einen Wert ab, der angibt, ob das Handle geschlossen ist. (Geerbt von SafeHandle) |
| IsInvalid |
Ruft einen Wert ab, der angibt, ob das Handle ungültig ist. |
| IsInvalid |
Ruft einen Wert ab, der angibt, ob das Handle ungültig ist. (Geerbt von SafeHandleZeroOrMinusOneIsInvalid) |
Methoden
| Name | Beschreibung |
|---|---|
| Close() |
Markiert das Handle zum Freigeben und Freigeben von Ressourcen. (Geerbt von SafeHandle) |
| DangerousAddRef(Boolean) |
Erhöht den Verweiszähler manuell auf SafeHandle Instanzen. (Geerbt von SafeHandle) |
| DangerousGetHandle() |
Gibt den Wert des handle Felds zurück. (Geerbt von SafeHandle) |
| DangerousRelease() |
Erhöht manuell den Verweiszähler für eine SafeHandle Instanz. (Geerbt von SafeHandle) |
| Dispose() |
Gibt alle Ressourcen frei, die von der SafeHandle-Klasse verwendet werden. (Geerbt von SafeHandle) |
| Dispose(Boolean) |
Gibt die von der Klasse verwendeten nicht verwalteten Ressourcen frei, die SafeHandle angeben, ob ein normaler Dispose-Vorgang ausgeführt werden soll. (Geerbt von SafeHandle) |
| Equals(Object) |
Bestimmt, ob das angegebene Objekt dem aktuellen Objekt entspricht. (Geerbt von Object) |
| GetHashCode() |
Dient als Standardhashfunktion. (Geerbt von Object) |
| GetType() |
Ruft die Type der aktuellen Instanz ab. (Geerbt von Object) |
| MemberwiseClone() |
Erstellt eine flache Kopie der aktuellen Object. (Geerbt von Object) |
| ReleaseHandle() |
Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird der code ausgeführt, der zum Freigeben des Handles erforderlich ist. (Geerbt von SafeHandle) |
| SetHandle(IntPtr) |
Legt den Handle auf den angegebenen vordefinierten Handle fest. (Geerbt von SafeHandle) |
| SetHandleAsInvalid() |
Markiert einen Handle als nicht mehr verwendet. (Geerbt von SafeHandle) |
| ToString() |
Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object) |