Export (0) Print
Expand All

SafeHandleZeroOrMinusOneIsInvalid Class

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

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

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

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

The SafeHandleZeroOrMinusOneIsInvalid type exposes the following members.

  NameDescription
Protected methodSafeHandleZeroOrMinusOneIsInvalidInitializes a new instance of the SafeHandleZeroOrMinusOneIsInvalid class, specifying whether the handle is to be reliably released.
Top

  NameDescription
Public propertyIsClosedGets a value indicating whether the handle is closed. (Inherited from SafeHandle.)
Public propertyIsInvalidGets a value that indicates whether the handle is invalid. (Overrides SafeHandle.IsInvalid.)
Top

  NameDescription
Public methodCloseMarks the handle for releasing and freeing resources. (Inherited from SafeHandle.)
Public methodDangerousAddRefManually increments the reference counter on SafeHandle instances. (Inherited from SafeHandle.)
Public methodDangerousGetHandleReturns the value of the handle field. (Inherited from SafeHandle.)
Public methodDangerousReleaseManually decrements the reference counter on a SafeHandle instance. (Inherited from SafeHandle.)
Public methodDispose()Releases all resources used by the SafeHandle class. (Inherited from SafeHandle.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the SafeHandle class specifying whether to perform a normal dispose operation. (Inherited from SafeHandle.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeFrees all resources associated with the handle. (Inherited from SafeHandle.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodReleaseHandleWhen overridden in a derived class, executes the code required to free the handle. (Inherited from SafeHandle.)
Protected methodSetHandleSets the handle to the specified pre-existing handle. (Inherited from SafeHandle.)
Public methodSetHandleAsInvalidMarks a handle as no longer used. (Inherited from SafeHandle.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Protected fieldhandleSpecifies the handle to be wrapped. (Inherited from SafeHandle.)
Top

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.

Important noteImportant

This type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the “Using an Object that Implements IDisposable” section in the IDisposable interface topic.

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

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

  • 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.

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, 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.

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