SafeFileHandle Klasa

Definicja

Przestrzeń nazw:

Microsoft.Win32.SafeHandles

Zestawy:

netstandard.dll, System.Runtime.dll

Źródło:

SafeFileHandle.cs

Reprezentuje klasę otoki dla uchwytu plików.

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

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

type SafeFileHandle = class
    inherit SafeHandleZeroOrMinusOneIsInvalid

Public NotInheritable Class SafeFileHandle
Inherits SafeHandleZeroOrMinusOneIsInvalid

Dziedziczenie

Object

CriticalFinalizerObject

SafeHandle

SafeHandleZeroOrMinusOneIsInvalid

SafeFileHandle

Przykłady

W poniższym przykładzie kodu pokazano, jak otworzyć plik przy użyciu SafeFileHandle klasy i funkcji niezarządzanej CreateFile .

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(nameof(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 (!handleValue.IsInvalid)
                return handleValue;
            
            return null;
        }
    }
}

Imports Microsoft.Win32.SafeHandles
Imports System.Runtime.InteropServices
Imports System.ComponentModel



Module SafeHandlesExample

    Sub Main()
        Try

            Dim loader As New UnmanagedFileLoader("example.xml")


        Catch e As Exception
            Console.WriteLine(e)
        End Try
        Console.ReadLine()

    End Sub
End Module



Class UnmanagedFileLoader


    Public Const FILE_ATTRIBUTE_NORMAL As Short = &H80
    Public Const INVALID_HANDLE_VALUE As Short = -1
    Public Const GENERIC_READ As Long = &H80000000
    Public Const GENERIC_WRITE As UInteger = &H40000000
    Public Const CREATE_NEW As UInteger = 1
    Public Const CREATE_ALWAYS As UInteger = 2
    Public Const OPEN_EXISTING As UInteger = 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)> _
    Private Shared Function CreateFile(ByVal lpFileName As String, ByVal dwDesiredAccess As System.UInt32, ByVal dwShareMode As System.UInt32, ByVal lpSecurityAttributes As IntPtr, ByVal dwCreationDisposition As System.UInt32, ByVal dwFlagsAndAttributes As System.UInt32, ByVal hTemplateFile As IntPtr) As Microsoft.Win32.SafeHandles.SafeFileHandle

    End Function


    Private handleValue As Microsoft.Win32.SafeHandles.SafeFileHandle = Nothing



    Public Sub New(ByVal Path As String)
        Load(Path)

    End Sub


    Public Sub Load(ByVal Path As String)
        If Path Is Nothing OrElse Path.Length = 0 Then
            Throw New ArgumentNullException("Path")
        End If

        ' 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 Then
            Marshal.ThrowExceptionForHR(Marshal.GetHRForLastWin32Error())
        End If

    End Sub


    Public ReadOnly Property Handle() As Microsoft.Win32.SafeHandles.SafeFileHandle
        Get
            ' If the handle is valid,
            ' return it.
            If Not handleValue.IsInvalid Then
                Return handleValue
            Else
                Return Nothing
            End If
        End Get
    End Property
End Class

Uwagi

Ta klasa pochodzi z klasy SafeHandleZeroOrMinusOneIsInvalid. Wartość 0 lub -1 jest nieprawidłowym dojściem do pliku.

Ważna

Ten typ implementuje interfejs IDisposable. Po zakończeniu korzystania z typu danych, należy go usunąć w sposób bezpośredni lub pośredni. Aby usunąć typ bezpośrednio, wywołaj metodę Dispose w bloku try/catch. Aby usunąć go pośrednio, należy użyć konstrukcji języka, takiej jak using (w języku C#) lub Using (w Visual Basic). Aby uzyskać więcej informacji, zobacz sekcję "Używanie obiektu implementującego IDisposable" (Using an Object that Implements IDisposable) w temacie interfejsu IDisposable.

Konstruktory

Nazwa	Opis
SafeFileHandle()	SafeFileHandle Tworzy wokół uchwytu pliku.
SafeFileHandle(IntPtr, Boolean)	Inicjuje nowe wystąpienie klasy SafeFileHandle.

Pola

Nazwa	Opis
handle	Określa uchwyt, który ma być opakowany. (Odziedziczone po SafeHandle)

Właściwości

Nazwa	Opis
IsAsync	Pobiera wartość, która określa, czy uchwyt jest asynchroniczny, czy nie.
IsClosed	Pobiera wartość wskazującą, czy uchwyt jest zamknięty. (Odziedziczone po SafeHandle)
IsInvalid	Pobiera wartość wskazującą, czy uchwyt jest nieprawidłowy.

Metody

Nazwa	Opis
Close()	Oznacza dojście do zwalniania i zwalniania zasobów. (Odziedziczone po SafeHandle)
DangerousAddRef(Boolean)	Ręczne zwiększanie licznika odwołania w SafeHandle wystąpieniach. (Odziedziczone po SafeHandle)
DangerousGetHandle()	Zwraca wartość handle pola. (Odziedziczone po SafeHandle)
DangerousRelease()	Ręczne dekrementuje licznik odwołań w wystąpieniu SafeHandle . (Odziedziczone po SafeHandle)
Dispose()	Zwalnia wszystkie zasoby używane przez klasę SafeHandle. (Odziedziczone po SafeHandle)
Dispose(Boolean)	Zwalnia niezarządzane zasoby używane przez klasę SafeHandle określającą, czy wykonać normalną operację usuwania. (Odziedziczone po SafeHandle)
Equals(Object)	Określa, czy określony obiekt jest równy bieżącemu obiektowi. (Odziedziczone po Object)
GetHashCode()	Służy jako domyślna funkcja skrótu. (Odziedziczone po Object)
GetType()	Pobiera Type bieżącego wystąpienia. (Odziedziczone po Object)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Object. (Odziedziczone po Object)
ReleaseHandle()	Po zastąpieniu w klasie pochodnej wykonuje kod wymagany do zwolnienia uchwytu. (Odziedziczone po SafeHandle)
SetHandle(IntPtr)	Ustawia dojście do określonego wstępnie istniejącego uchwytu. (Odziedziczone po SafeHandle)
SetHandleAsInvalid()	Oznacza uchwyt jako nieużytny. (Odziedziczone po SafeHandle)
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)

Zobacz też

• SafeHandle
• SafeHandleZeroOrMinusOneIsInvalid