SafeFileHandle クラス

リファレンス

定義

名前空間:: Microsoft.Win32.SafeHandles

アセンブリ:: mscorlib.dll, System.IO.FileSystem.dll

アセンブリ:: System.Runtime.dll

アセンブリ:: System.IO.FileSystem.dll

アセンブリ:: mscorlib.dll

アセンブリ:: netstandard.dll

ソース:: SafeFileHandle.cs

ソース:: SafeFileHandle.cs

ソース:: SafeFileHandle.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

ファイルハンドルのラッパークラスを表します。

public ref class SafeFileHandle sealed : System::Runtime::InteropServices::SafeHandle

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

[System.Security.SecurityCritical]
public sealed class SafeFileHandle : System.Runtime.InteropServices.SafeHandle

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

[System.Security.SecurityCritical]
public sealed class SafeFileHandle : Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid

[<System.Security.SecurityCritical>]
type SafeFileHandle = class
    inherit SafeHandle

type SafeFileHandle = class
    inherit SafeHandleZeroOrMinusOneIsInvalid

[<System.Security.SecurityCritical>]
type SafeFileHandle = class
    inherit SafeHandleZeroOrMinusOneIsInvalid

Public NotInheritable Class SafeFileHandle
Inherits SafeHandle

Public NotInheritable Class SafeFileHandle
Inherits SafeHandleZeroOrMinusOneIsInvalid

継承: Object

SafeHandle
SafeFileHandle

継承: Object

CriticalFinalizerObject

SafeHandle

SafeHandleZeroOrMinusOneIsInvalid
SafeFileHandle

属性: SecurityCriticalAttribute

例

次のコード例では、クラスとアンマネージ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	ハンドルが無効かどうかを示す値を取得します。
IsInvalid	ハンドルが無効かどうかを示す値を取得します。 (継承元 SafeHandleZeroOrMinusOneIsInvalid)

メソッド

Close()	リソースを解放するためのハンドルをマークします。 (継承元 SafeHandle)
DangerousAddRef(Boolean)	SafeHandle インスタンスの参照カウンターを手動でインクリメントします。 (継承元 SafeHandle)
DangerousGetHandle()	handle フィールドの値を戻します。 (継承元 SafeHandle)
DangerousRelease()	SafeHandle インスタンスの参照カウンターを手動でデクリメントします。 (継承元 SafeHandle)
Dispose()	SafeHandle クラスによって使用されているすべてのリソースを解放します。 (継承元 SafeHandle)
Dispose(Boolean)	通常の破棄操作を実行するかどうかを指定して、SafeHandle クラスによって使用されているアンマネージリソースを解放します。 (継承元 SafeHandle)
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ReleaseHandle()	派生クラスでオーバーライドされると、ハンドルを解放するために必要なコードを実行します。 (継承元 SafeHandle)
SetHandle(IntPtr)	ハンドルを指定した既存のハンドルに設定します。 (継承元 SafeHandle)
SetHandleAsInvalid()	今後は使用しないものとしてハンドルをマークします。 (継承元 SafeHandle)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

適用対象

次の方法で共有