SafeFileHandle Classe

Définition

Espace de noms:

Microsoft.Win32.SafeHandles

Assembly:

System.Runtime.dll

Source:

SafeFileHandle.cs

Représente une classe wrapper pour un handle de fichier.

C#

public sealed class SafeFileHandle : Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid

Héritage

Object

CriticalFinalizerObject

SafeHandle

SafeHandleZeroOrMinusOneIsInvalid

SafeFileHandle

Exemples

L’exemple de code suivant montre comment ouvrir un fichier à l’aide de la SafeFileHandle classe et de la fonction non managée 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;
            }
        }
    }
}

Remarques

Cette classe est dérivée de SafeHandleZeroOrMinusOneIsInvalid. Une valeur de 0 ou -1 est un handle de fichier non valide.

Important

Ce type implémente l'interface IDisposable. Une fois que vous avez fini d’utiliser le type, vous devez le supprimer directement ou indirectement. Pour supprimer directement le type Dispose, appelez sa méthode dans un bloc try/catch. Pour la supprimer indirectement, utilisez une construction de langage telle que using (dans C#) ou Using (dans Visual Basic). Pour plus d’informations, consultez la section « Utilisation d’un objet qui implémente IDisposable » dans la rubrique de l’interface IDisposable.

Constructeurs

SafeFileHandle()	Crée un autour d’un SafeFileHandle handle de fichier.
SafeFileHandle(IntPtr, Boolean)	Initialise une nouvelle instance de la classe SafeFileHandle.

Champs

handle

Spécifie le handle à encapsuler. (Hérité de SafeHandle)

Propriétés

IsAsync	Obtient une valeur qui détermine si le handle est asynchrone ou non.
IsClosed	Obtient une valeur indiquant si le handle est fermé. (Hérité de SafeHandle)
IsInvalid	Obtient une valeur qui indique si le handle n'est pas valide.

Méthodes

Close()	Marque le handle pour libérer des ressources. (Hérité de SafeHandle)
DangerousAddRef(Boolean)	Incrémente manuellement le compteur de références sur les instances de SafeHandle. (Hérité de SafeHandle)
DangerousGetHandle()	Retourne la valeur du champ handle. (Hérité de SafeHandle)
DangerousRelease()	Décrémente manuellement le compteur de références sur une instance de SafeHandle. (Hérité de SafeHandle)
Dispose()	Libère toutes les ressources utilisées par la classe SafeHandle. (Hérité de SafeHandle)
Dispose(Boolean)	Libère les ressources non managées utilisées par la classe SafeHandle, en spécifiant s'il faut exécuter une opération de suppression normale. (Hérité de SafeHandle)
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ReleaseHandle()	En cas de substitution dans une classe dérivée, exécute le code nécessaire pour libérer le handle. (Hérité de SafeHandle)
SetHandle(IntPtr)	Définit le handle au handle préexistant spécifié. (Hérité de SafeHandle)
SetHandleAsInvalid()	Marque un handle comme n'étant plus utilisé. (Hérité de SafeHandle)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

S’applique à

Voir aussi

• SafeHandle
• SafeHandleZeroOrMinusOneIsInvalid