0 out of 1 rated this helpful - Rate this topic

SafeWaitHandle Class

.NET Framework 4.5

Represents a wrapper class for a wait handle.

System.Object
  System.Runtime.ConstrainedExecution.CriticalFinalizerObject
    System.Runtime.InteropServices.SafeHandle
      Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid
        Microsoft.Win32.SafeHandles.SafeWaitHandle

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

Syntax

C++

[<Sealed>]
type SafeWaitHandle =  
    class 
        inherit SafeHandleZeroOrMinusOneIsInvalid 
    end

The SafeWaitHandle type exposes the following members.

Constructors

	Name	Description
	SafeWaitHandle	Initializes a new instance of the SafeWaitHandle class.

Top

Properties

	Name	Description
	IsClosed	Gets a value indicating whether the handle is closed. (Inherited from SafeHandle.)
	IsInvalid	Gets a value that indicates whether the handle is invalid. (Inherited from SafeHandleZeroOrMinusOneIsInvalid.)

Top

Methods

	Name	Description
	Close	Marks the handle for releasing and freeing resources. (Inherited from SafeHandle.)
	DangerousAddRef	Manually increments the reference counter on SafeHandle instances. (Inherited from SafeHandle.)
	DangerousGetHandle	Returns the value of the handle field. (Inherited from SafeHandle.)
	DangerousRelease	Manually decrements the reference counter on a SafeHandle instance. (Inherited from SafeHandle.)
	Dispose()	Releases all resources used by the SafeHandle class. (Inherited from SafeHandle.)
	Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	SetHandleAsInvalid	Marks a handle as no longer used. (Inherited from SafeHandle.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

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

Examples

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

No code example is currently available or this language may not be supported.

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET Framework Security

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

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety

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

Reference

Microsoft.Win32.SafeHandles Namespace

SafeHandleZeroOrMinusOneIsInvalid

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)