SafeFileHandle 類別

定義

命名空間:

Microsoft.Win32.SafeHandles

組件:

System.Runtime.dll

來源:

SafeFileHandle.cs

代表檔案控制代碼的包裝函式類別。

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

繼承

Object

CriticalFinalizerObject

SafeHandle

SafeHandleZeroOrMinusOneIsInvalid

SafeFileHandle

範例

下列程式代碼範例示範如何使用 類別和 Unmanaged 函式CreateFile開啟檔案SafeFileHandle。

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;
            }
        }
    }
}

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

備註

此類別衍生自 SafeHandleZeroOrMinusOneIsInvalid。 值為 0 或 -1 是無效的檔案句柄。

重要

此型別代表 IDisposable 介面。 當您完成使用型別時，您應該直接或間接處置它。 若要直接處置型別，請呼叫其 try/catch 區塊中的 Dispose 方法。 若要間接處置它，請使用語言建構函式，例如 using (在 C# 中) 或 Using (在 Visual Basic 中)。 如需詳細資訊，請參閱 IDisposable 介面文章中的＜使用實作 IDisposable 的物件＞一節。

建構函式

SafeFileHandle()	在 SafeFileHandle 檔案句柄周圍建立 。
SafeFileHandle(IntPtr, Boolean)	初始化 SafeFileHandle 類別的新執行個體。

欄位

handle

指定要包裝的控制代碼。 (繼承來源 SafeHandle)

屬性

IsAsync	取得值，這個值會判斷句柄是否為異步。
IsClosed	取得值，指出控制代碼是否已關閉。 (繼承來源 SafeHandle)
IsInvalid	取得值，表示控制代碼是否無效。

方法

Close()	標記要釋出和釋放資源的控制代碼。 (繼承來源 SafeHandle)
DangerousAddRef(Boolean)	手動遞增 SafeHandle 執行個體上的參考計數器。 (繼承來源 SafeHandle)
DangerousGetHandle()	傳回 handle 欄位的值。 (繼承來源 SafeHandle)
DangerousRelease()	手動遞減 SafeHandle 執行個體上的參考計數器。 (繼承來源 SafeHandle)
Dispose()	釋放 SafeHandle 類別所使用的所有資源。 (繼承來源 SafeHandle)
Dispose(Boolean)	釋放 SafeHandle 類別所使用的 Unmanaged 資源，指定是否要執行一般處置作業。 (繼承來源 SafeHandle)
Equals(Object)	判斷指定的物件是否等於目前的物件。 (繼承來源 Object)
GetHashCode()	做為預設雜湊函式。 (繼承來源 Object)
GetType()	取得目前執行個體的 Type。 (繼承來源 Object)
MemberwiseClone()	建立目前 Object 的淺層複製。 (繼承來源 Object)
ReleaseHandle()	在衍生類別中覆寫時，執行釋放控制代碼所需的程式碼。 (繼承來源 SafeHandle)
SetHandle(IntPtr)	將控制代碼設定為指定的既有控制代碼。 (繼承來源 SafeHandle)
SetHandleAsInvalid()	將控制代碼標記為不再使用。 (繼承來源 SafeHandle)
ToString()	傳回代表目前物件的字串。 (繼承來源 Object)

另請參閱

• SafeHandle
• SafeHandleZeroOrMinusOneIsInvalid