SafeWaitHandle Classe
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Representa uma classe de wrapper para um handle de espera.
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
- Herança
- Herança
- Atributos
Exemplos
O exemplo de código seguinte demonstra como usar interop para criar um mutex usando a SafeWaitHandle classe e a função não gerida CreateMutex .
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
Observações
A SafeWaitHandle classe é utilizada pela System.Threading.WaitHandle turma. É um wrapper para mutexes do Win32 e eventos de reset automático e manual.
Importante
Este tipo implementa a interface IDisposable. Quando terminar de usar o tipo, você deve eliminá-lo direta ou indiretamente. Para descartar o tipo diretamente, chame seu método Dispose em um bloco try/catch. Para descartá-lo indiretamente, use uma construção de linguagem como using (em C#) ou Using (em Visual Basic).
Construtores
| Name | Descrição |
|---|---|
| SafeWaitHandle() |
Cria um SafeWaitHandle. |
| SafeWaitHandle(IntPtr, Boolean) |
Inicializa uma nova instância da SafeWaitHandle classe. |
Campos
| Name | Descrição |
|---|---|
| handle |
Especifica o cabo a enrolar. (Herdado de SafeHandle) |
Propriedades
| Name | Descrição |
|---|---|
| IsClosed |
Obtém um valor que indica se a pega está fechada. (Herdado de SafeHandle) |
| IsInvalid |
Recebe um valor que indica se o handle é inválido. |
| IsInvalid |
Recebe um valor que indica se o handle é inválido. (Herdado de SafeHandleZeroOrMinusOneIsInvalid) |
Métodos
| Name | Descrição |
|---|---|
| Close() |
Marca o nome para libertar e libertar recursos. (Herdado de SafeHandle) |
| DangerousAddRef(Boolean) |
Incrementa manualmente o contador de referência nas SafeHandle instâncias. (Herdado de SafeHandle) |
| DangerousGetHandle() |
Devolve o valor do handle campo. (Herdado de SafeHandle) |
| DangerousRelease() |
Decrementa manualmente o contador de referência numa SafeHandle instância. (Herdado de SafeHandle) |
| Dispose() |
Liberta todos os recursos usados pela SafeHandle turma. (Herdado de SafeHandle) |
| Dispose(Boolean) |
Liberta os recursos não geridos usados pela SafeHandle classe especificando se deve realizar uma operação normal de eliminação. (Herdado de SafeHandle) |
| Equals(Object) |
Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object) |
| GetHashCode() |
Serve como função de hash predefinida. (Herdado de Object) |
| GetType() |
Obtém o Type da instância atual. (Herdado de Object) |
| MemberwiseClone() |
Cria uma cópia superficial do atual Object. (Herdado de Object) |
| ReleaseHandle() |
Quando sobrescrito numa classe derivada, executa o código necessário para libertar o handle. (Herdado de SafeHandle) |
| SetHandle(IntPtr) |
Define a alavanca para a alavanca pré-existente especificada. (Herdado de SafeHandle) |
| SetHandleAsInvalid() |
Marca uma pega como já não usada. (Herdado de SafeHandle) |
| ToString() |
Devolve uma cadeia que representa o objeto atual. (Herdado de Object) |