This topic has not yet been rated - Rate this topic

SafeHandleZeroOrMinusOneIsInvalid Class

.NET Framework 4

Provides a base class for Win32 safe handle implementations in which the value of either 0 or -1 indicates an invalid handle.

Inheritance Hierarchy

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

Syntax

C++

Copy

[SecurityPermissionAttribute(SecurityAction.InheritanceDemand, UnmanagedCode = true)]
public abstract class SafeHandleZeroOrMinusOneIsInvalid : SafeHandle

The SafeHandleZeroOrMinusOneIsInvalid type exposes the following members.

Constructors

	Name	Description
	SafeHandleZeroOrMinusOneIsInvalid	Initializes a new instance of the SafeHandleZeroOrMinusOneIsInvalid class, specifying whether the handle is to be reliably released.

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. (Overrides SafeHandle.IsInvalid.)

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.)
	Dispose(Boolean)	Releases the unmanaged resources used by the SafeHandle class specifying whether to perform a normal dispose operation. (Inherited from SafeHandle.)
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Frees all resources associated with the handle. (Inherited from SafeHandle.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReleaseHandle	When overridden in a derived class, executes the code required to free the handle. (Inherited from SafeHandle.)
	SetHandle	Sets the handle to the specified pre-existing handle. (Inherited from SafeHandle.)
	SetHandleAsInvalid	Marks a handle as no longer used. (Inherited from SafeHandle.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	handle	Specifies the handle to be wrapped. (Inherited from SafeHandle.)

Top

Remarks

This class derives from the System.Runtime.InteropServices.SafeHandle class. It describes the format of an invalid handle. For example, some handles use -1 as an invalid handle value, while others use 0. Further derivations of this class (for example, file or registry handles) can specialize this further. See the SafeFileHandle class for an example of a class that derives from SafeHandleZeroOrMinusOneIsInvalid.

Use the SafeHandleZeroOrMinusOneIsInvalid class whenever you need to safely wrap an unmanaged resource that does not have an existing managed wrapper.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET Framework Security

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

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.