SafeHandleZeroOrMinusOneIsInvalid Class

SafeHandleZeroOrMinusOneIsInvalid Class

 

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

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


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

NameDescription
System_CAPS_protmethodSafeHandleZeroOrMinusOneIsInvalid(Boolean)

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

NameDescription
System_CAPS_pubpropertyIsClosed

Gets a value indicating whether the handle is closed.(Inherited from SafeHandle.)

System_CAPS_pubpropertyIsInvalid

Gets a value that indicates whether the handle is invalid.(Overrides SafeHandle.IsInvalid.)

NameDescription
System_CAPS_pubmethodClose()

Marks the handle for releasing and freeing resources.(Inherited from SafeHandle.)

System_CAPS_pubmethodDangerousAddRef(Boolean)

Manually increments the reference counter on SafeHandle instances.(Inherited from SafeHandle.)

System_CAPS_pubmethodDangerousGetHandle()

Returns the value of the handle field.(Inherited from SafeHandle.)

System_CAPS_pubmethodDangerousRelease()

Manually decrements the reference counter on a SafeHandle instance.(Inherited from SafeHandle.)

System_CAPS_pubmethodDispose()

Releases all resources used by the SafeHandle class.(Inherited from SafeHandle.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the SafeHandle class specifying whether to perform a normal dispose operation.(Inherited from SafeHandle.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Frees all resources associated with the handle.(Inherited from SafeHandle.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodReleaseHandle()

When overridden in a derived class, executes the code required to free the handle.(Inherited from SafeHandle.)

System_CAPS_protmethodSetHandle(IntPtr)

Sets the handle to the specified pre-existing handle.(Inherited from SafeHandle.)

System_CAPS_pubmethodSetHandleAsInvalid()

Marks a handle as no longer used.(Inherited from SafeHandle.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_protfieldhandle

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

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.

System_CAPS_importantImportant

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.

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.

.NET Framework
Available since 2.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

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

Return to top
Show:
© 2016 Microsoft