Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

SafeFileHandle Class

Represents a wrapper class for a file handle.

Namespace:  Microsoft.Win32.SafeHandles
Assembly:  mscorlib (in mscorlib.dll)
public ref class SafeFileHandle sealed : public SafeHandleZeroOrMinusOneIsInvalid

The SafeFileHandle type exposes the following members.

  NameDescription
Public methodSafeFileHandleInitializes a new instance of the SafeFileHandle class.
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. (Inherited from SafeHandleZeroOrMinusOneIsInvalid.)
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.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSetHandleAsInvalidMarks a handle as no longer used. (Inherited from SafeHandle.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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

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.

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.

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
  • 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.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.