SafeHandleZeroOrMinusOneIsInvalid Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides a base class for Win32 safe handle implementations in which the value of either 0 or -1 indicates an invalid handle.
public ref class SafeHandleZeroOrMinusOneIsInvalid abstract : System::Runtime::InteropServices::SafeHandle
public abstract class SafeHandleZeroOrMinusOneIsInvalid : System.Runtime.InteropServices.SafeHandle
[System.Security.SecurityCritical]
public abstract class SafeHandleZeroOrMinusOneIsInvalid : System.Runtime.InteropServices.SafeHandle
type SafeHandleZeroOrMinusOneIsInvalid = class
inherit SafeHandle
[<System.Security.SecurityCritical>]
type SafeHandleZeroOrMinusOneIsInvalid = class
inherit SafeHandle
Public MustInherit Class SafeHandleZeroOrMinusOneIsInvalid
Inherits SafeHandle
- Inheritance
- Derived
- Attributes
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.
Important
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.
Constructors
SafeHandleZeroOrMinusOneIsInvalid(Boolean) |
Initializes a new instance of the SafeHandleZeroOrMinusOneIsInvalid class, specifying whether the handle is to be reliably released. |
Fields
handle |
Specifies the handle to be wrapped. (Inherited from SafeHandle) |
Properties
IsClosed |
Gets a value indicating whether the handle is closed. (Inherited from SafeHandle) |
IsInvalid |
Gets a value that indicates whether the handle is invalid. |
Methods
Close() |
Marks the handle for releasing and freeing resources. (Inherited from SafeHandle) |
DangerousAddRef(Boolean) |
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) |
GetHashCode() |
Serves as the default hash function. (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(IntPtr) |
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) |