英語で読む

次の方法で共有


SafeFileHandle クラス

定義

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

[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
継承
SafeFileHandle
継承
属性

次のコード例では、 クラスとアンマネージ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;
            }
        }
    }
}

注釈

このクラスは、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)

適用対象

製品 バージョン
.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

こちらもご覧ください