SafeFileHandle Class

 

Represents a wrapper class for a file handle.

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


[<Sealed>]
[<SecurityCriticalAttribute>]
type SafeFileHandle = 
    class
        inherit SafeHandleZeroOrMinusOneIsInvalid
    end

NameDescription
System_CAPS_pubmethodSafeFileHandle(IntPtr, Boolean)

Initializes a new instance of the SafeFileHandle class.

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.(Inherited from SafeHandleZeroOrMinusOneIsInvalid.)

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_pubmethodEquals(Object)

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

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_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.)

This class is derived from SafeHandleZeroOrMinusOneIsInvalid. A value of 0 or -1 is an invalid file handle.

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.

The following code example demonstrates how to open a file using the SafeFileHandle class and the unmanaged CreateFile function.

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

SecurityCriticalAttribute

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

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.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: