Leer en inglés

Compartir a través de


SafeFileHandle Clase

Definición

Representa una clase contenedora para un controlador de archivo.

C#
[System.Security.SecurityCritical]
public sealed class SafeFileHandle : System.Runtime.InteropServices.SafeHandle
C#
public sealed class SafeFileHandle : Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid
C#
[System.Security.SecurityCritical]
public sealed class SafeFileHandle : Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid
Herencia
SafeFileHandle
Herencia
Atributos

Ejemplos

En el ejemplo de código siguiente se muestra cómo abrir un archivo mediante la SafeFileHandle clase y la función no administrada CreateFile .

C#
using System;
using Microsoft.Win32.SafeHandles;
using System.Runtime.InteropServices;
using System.ComponentModel;

class SafeHandlesExample
{

    static void Main()
    {
        try
        {

            UnmanagedFileLoader loader = new UnmanagedFileLoader("example.xml");
        }
        catch (Exception e)
        {
            Console.WriteLine(e);
        }
        Console.ReadLine();
    }
}

class UnmanagedFileLoader
{

    public const short FILE_ATTRIBUTE_NORMAL = 0x80;
    public const short INVALID_HANDLE_VALUE = -1;
    public const uint GENERIC_READ = 0x80000000;
    public const uint GENERIC_WRITE = 0x40000000;
    public const uint CREATE_NEW = 1;
    public const uint CREATE_ALWAYS = 2;
    public const uint OPEN_EXISTING = 3;

    // Use interop to call the CreateFile function.
    // For more information about CreateFile,
    // see the unmanaged MSDN reference library.
    [DllImport("kernel32.dll", SetLastError = true, CharSet=CharSet.Unicode)]
    static extern SafeFileHandle CreateFile(string lpFileName, uint dwDesiredAccess,
      uint dwShareMode, IntPtr lpSecurityAttributes, uint dwCreationDisposition,
      uint dwFlagsAndAttributes, IntPtr hTemplateFile);

    private SafeFileHandle handleValue = null;

    public UnmanagedFileLoader(string Path)
    {
        Load(Path);
    }

    public void Load(string Path)
    {
        if (Path == null || Path.Length == 0)
        {
            throw new ArgumentNullException("Path");
        }

        // Try to open the file.
        handleValue = CreateFile(Path, GENERIC_WRITE, 0, IntPtr.Zero, OPEN_EXISTING, 0, IntPtr.Zero);

        // If the handle is invalid,
        // get the last Win32 error
        // and throw a Win32Exception.
        if (handleValue.IsInvalid)
        {
            Marshal.ThrowExceptionForHR(Marshal.GetHRForLastWin32Error());
        }
    }

    public SafeFileHandle Handle
    {
        get
        {
            // If the handle is valid,
            // return it.
            if (!handleValue.IsInvalid)
            {
                return handleValue;
            }
            else
            {
                return null;
            }
        }
    }
}

Comentarios

Esta clase se deriva de SafeHandleZeroOrMinusOneIsInvalid. Un valor de 0 o -1 es un identificador de archivo no válido.

Importante

Este tipo implementa la interfaz IDisposable. Cuando haya terminado de utilizar el tipo, debe desecharlo directa o indirectamente. Para eliminar el tipo directamente, llame a su método Dispose en un bloque try/catch. Para deshacerse de él indirectamente, use una construcción de lenguaje como using (en C#) o Using (en Visual Basic). Para más información, vea la sección "Uso de objetos que implementan IDisposable" en el tema de la interfaz IDisposable.

Constructores

SafeFileHandle()

Crea un alrededor SafeFileHandle de un identificador de archivo.

SafeFileHandle(IntPtr, Boolean)

Inicializa una nueva instancia de la clase SafeFileHandle.

Campos

handle

Especifica el identificador que se va a ajustar.

(Heredado de SafeHandle)

Propiedades

IsAsync

Obtiene un valor que determina si el identificador es asincrónico o no.

IsClosed

Obtiene un valor que indica si el identificador está cerrado.

(Heredado de SafeHandle)
IsInvalid

Obtiene un valor que indica si el identificador no es válido.

IsInvalid

Obtiene un valor que indica si el identificador no es válido.

(Heredado de SafeHandleZeroOrMinusOneIsInvalid)

Métodos

Close()

Marca el identificador para soltar y liberar recursos.

(Heredado de SafeHandle)
DangerousAddRef(Boolean)

Aumenta manualmente el recuento de referencias en instancias de SafeHandle.

(Heredado de SafeHandle)
DangerousGetHandle()

Devuelve el valor del campo handle.

(Heredado de SafeHandle)
DangerousRelease()

Disminuye manualmente el recuento de referencias en una instancia de SafeHandle.

(Heredado de SafeHandle)
Dispose()

Libera todos los recursos que utiliza la clase SafeHandle.

(Heredado de SafeHandle)
Dispose(Boolean)

Libera los recursos no administrados usados por la clase SafeHandle especificando si se lleva a cabo una operación de eliminación normal.

(Heredado de SafeHandle)
Equals(Object)

Determina si el objeto especificado es igual que el objeto actual.

(Heredado de Object)
GetHashCode()

Sirve como la función hash predeterminada.

(Heredado de Object)
GetType()

Obtiene el Type de la instancia actual.

(Heredado de Object)
MemberwiseClone()

Crea una copia superficial del Object actual.

(Heredado de Object)
ReleaseHandle()

Cuando se invalida en una clase derivada, ejecuta el código necesario para liberar el identificador.

(Heredado de SafeHandle)
SetHandle(IntPtr)

Establece el identificador en el identificador preexistente.

(Heredado de SafeHandle)
SetHandleAsInvalid()

Marca un identificador para indicar que ya no se utiliza.

(Heredado de SafeHandle)
ToString()

Devuelve una cadena que representa el objeto actual.

(Heredado de Object)

Se aplica a

Producto Versiones
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

Consulte también