SafeWaitHandle Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Представляет класс-оболочку для дескриптора ожидания.
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
- Наследование
- Наследование
- Атрибуты
Примеры
В следующем примере кода показано, как использовать взаимодействие для создания мьютекса с помощью SafeWaitHandle класса и неуправляемой 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
Комментарии
Класс SafeWaitHandle используется классом System.Threading.WaitHandle . Это оболочка для мьютексов Win32 и автоматического и ручного сброса событий.
Important
Этот тип реализует IDisposable интерфейс. Завершив использование типа, следует избавиться от него напрямую или косвенно. Чтобы удалить тип напрямую, вызовите его Dispose метод в блоке try/catch . Чтобы удалить его косвенно, используйте конструкцию языка, например using (в C#) или Using (в Visual Basic).
Конструкторы
| Имя | Описание |
|---|---|
| SafeWaitHandle() |
Создает объект SafeWaitHandle. |
| SafeWaitHandle(IntPtr, Boolean) |
Инициализирует новый экземпляр класса SafeWaitHandle. |
Поля
| Имя | Описание |
|---|---|
| handle |
Указывает дескриптор, который необходимо упаковать. (Унаследовано от SafeHandle) |
Свойства
| Имя | Описание |
|---|---|
| IsClosed |
Возвращает значение, указывающее, закрыт ли дескриптор. (Унаследовано от SafeHandle) |
| IsInvalid |
Возвращает значение, указывающее, является ли дескриптор недопустимым. |
| IsInvalid |
Возвращает значение, указывающее, является ли дескриптор недопустимым. (Унаследовано от SafeHandleZeroOrMinusOneIsInvalid) |
Методы
| Имя | Описание |
|---|---|
| Close() |
Помечает дескриптор для освобождения и освобождения ресурсов. (Унаследовано от SafeHandle) |
| DangerousAddRef(Boolean) |
Вручную увеличивает счетчик ссылок на SafeHandle экземпляры. (Унаследовано от SafeHandle) |
| DangerousGetHandle() |
Возвращает значение handle поля. (Унаследовано от SafeHandle) |
| DangerousRelease() |
Вручную уменьшает счетчик ссылок в экземпляре SafeHandle . (Унаследовано от SafeHandle) |
| Dispose() |
Освобождает все ресурсы, используемые классом SafeHandle . (Унаследовано от SafeHandle) |
| Dispose(Boolean) |
Освобождает неуправляемые ресурсы, используемые SafeHandle классом, указывающим, следует ли выполнять обычную операцию удаления. (Унаследовано от SafeHandle) |
| Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
| GetHashCode() |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
| GetType() |
Возвращает Type текущего экземпляра. (Унаследовано от Object) |
| MemberwiseClone() |
Создает неглубокую копию текущей Object. (Унаследовано от Object) |
| ReleaseHandle() |
При переопределении в производном классе выполняет код, необходимый для освобождения дескриптора. (Унаследовано от SafeHandle) |
| SetHandle(IntPtr) |
Задает дескриптор указанному предварительно существующему дескриптору. (Унаследовано от SafeHandle) |
| SetHandleAsInvalid() |
Помечает дескриптор, который больше не используется. (Унаследовано от SafeHandle) |
| ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |