SafeFileHandle

.NET Framework クラス ライブラリ リファレンス

SafeFileHandle クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

ファイル ハンドルのラッパー クラスを表します。このクラスは継承できません。

名前空間: Microsoft.Win32.SafeHandles
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 SafeFileHandle
    Inherits SafeHandleZeroOrMinusOneIsInvalid

Visual Basic (使用法)

Dim instance As SafeFileHandle

C#

public sealed class SafeFileHandle : SafeHandleZeroOrMinusOneIsInvalid

C++

public ref class SafeFileHandle sealed : public
 SafeHandleZeroOrMinusOneIsInvalid

J#

public final class SafeFileHandle extends SafeHandleZeroOrMinusOneIsInvalid

JScript

public final class SafeFileHandle extends
 SafeHandleZeroOrMinusOneIsInvalid

解説

このクラスは、SafeHandleZeroOrMinusOneIsInvalid の派生クラスです。値 0 または -1 は無効なファイル ハンドルです。

使用例

SafeFileHandle クラスおよび CreateFile アンマネージ関数を使用してファイルを開く方法のコード例を次に示します。

Visual Basic

Imports System
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)>
 _
    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 SafeFileHandle

    End Function


    Private handleValue As SafeFileHandle =
 Nothing



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

    End Sub


    Public Sub Load(ByVal
 Path As String)
        If Path Is Nothing
 AndAlso 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.GetLastWin32Error())
        End If

    End Sub


    Public ReadOnly Property
 Handle() As 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

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)]
    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.GetLastWin32Error());
        }
    }

    public SafeFileHandle Handle
    {
        get
        {
            // If the handle is valid,
            // return it.
            if (!handleValue.IsInvalid)
            {
                return handleValue;
            }
            else
            {
                return null;
            }
        }

    }

}

継承階層

System.Object
   System.Runtime.ConstrainedExecution.CriticalFinalizerObject
     System.Runtime.InteropServices.SafeHandle
       Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid
        Microsoft.Win32.SafeHandles.SafeFileHandle

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SafeFileHandle メンバ
Microsoft.Win32.SafeHandles 名前空間
SafeHandle
SafeHandleZeroOrMinusOneIsInvalid

SafeFileHandle コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

SafeFileHandle クラスの新しいインスタンスを初期化します。

名前空間: Microsoft.Win32.SafeHandles
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    preexistingHandle As IntPtr, _
    ownsHandle As Boolean _
)

Visual Basic (使用法)

Dim preexistingHandle As IntPtr
Dim ownsHandle As Boolean

Dim instance As New SafeFileHandle(preexistingHandle,
 ownsHandle)

C#

public SafeFileHandle (
    IntPtr preexistingHandle,
    bool ownsHandle
)

C++

public:
SafeFileHandle (
    IntPtr preexistingHandle, 
    bool ownsHandle
)

J#

public SafeFileHandle (
    IntPtr preexistingHandle, 
    boolean ownsHandle
)

JScript

public function SafeFileHandle (
    preexistingHandle : IntPtr, 
    ownsHandle : boolean
)

パラメータ

preexistingHandle

使用する既存のハンドルを表す IntPtr オブジェクト。

ownsHandle

終了処理中にハンドルを安全に解放する場合は true。安全な解放を行わない場合は false (お勧めしません)。

使用例

SafeFileHandle クラスおよび CreateFile アンマネージ関数を使用してファイルを開く方法のコード例を次に示します。

Visual Basic

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



Class SafeHandlesExample


    Shared Sub Main()
        Try

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


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

    End Sub
End Class


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)>
 _
    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 IntPtr

    End Function

    Private handleValue As SafeFileHandle =
 Nothing



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

    End Sub


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

        ' Try to open the file.

        Dim ptr As IntPtr = CreateFile(Path,
 GENERIC_WRITE, 0, IntPtr.Zero, OPEN_EXISTING, 0, IntPtr.Zero)

        handleValue = New SafeFileHandle(ptr, True)
        ' If the handle is invalid,
        ' get the last Win32 error 
        ' and throw a Win32Exception.
        If handleValue.IsInvalid Then
            Marshal.ThrowExceptionForHR(Marshal.GetLastWin32Error())
        End If

    End Sub


    Public ReadOnly Property
 Handle() As 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

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)]
    static extern IntPtr 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.
        IntPtr ptr = CreateFile(Path, GENERIC_WRITE, 0, IntPtr.Zero, OPEN_EXISTING,
 0, IntPtr.Zero);

        handleValue = new SafeFileHandle(ptr, true);

        // If the handle is invalid,
         // get the last Win32 error 
         // and throw a Win32Exception.
         if (handleValue.IsInvalid)
         {
             Marshal.ThrowExceptionForHR(Marshal.GetLastWin32Error());
         }
    }

    public SafeFileHandle Handle
    {
        get
        {
            // If the handle is valid,
            // return it.
            if (!handleValue.IsInvalid)
            {
                return handleValue;
            }
            else
            {
                return null;
            }
        }

    }

}

.NET Framework のセキュリティ

• SecurityPermission  (アンマネージ コードを呼び出すために必要なアクセス許可)。 LinkDemand (セキュリティ アクション)。 UnmanagedCode (関連する列挙体)

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SafeFileHandle クラス
SafeFileHandle メンバ
Microsoft.Win32.SafeHandles 名前空間
SafeHandle

SafeFileHandle プロパティ

パブリック プロパティ

	名前	説明
	IsClosed	ハンドルが閉じているかどうかを示す値を取得します。 ( SafeHandle から継承されます。)
	IsInvalid	ハンドルが無効かどうかを示す値を取得します。 ( SafeHandleZeroOrMinusOneIsInvalid から継承されます。)

参照

関連項目

SafeFileHandle クラス
Microsoft.Win32.SafeHandles 名前空間
SafeHandle
SafeHandleZeroOrMinusOneIsInvalid

SafeFileHandle メソッド

パブリック メソッド

	名前	説明
	Close	リソースを解放するためのハンドルをマークします。 ( SafeHandle から継承されます。)
	DangerousAddRef	SafeHandle インスタンスの参照カウンタを手動でインクリメントします。 ( SafeHandle から継承されます。)
	DangerousGetHandle	handle フィールドの値を返します。 ( SafeHandle から継承されます。)
	DangerousRelease	SafeHandle インスタンスの参照カウンタを手動でデクリメントします。 ( SafeHandle から継承されます。)
	Dispose	SafeHandle クラスによって使用されているすべてのリソースを解放します。 ( SafeHandle から継承されます。)
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	SetHandleAsInvalid	今後は使用しないものとしてハンドルをマークします。 ( SafeHandle から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

参照

関連項目

SafeFileHandle クラス
Microsoft.Win32.SafeHandles 名前空間
SafeHandle
SafeHandleZeroOrMinusOneIsInvalid

SafeFileHandle メンバ

ファイル ハンドルのラッパー クラスを表します。このクラスは継承できません。

SafeFileHandle データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	SafeFileHandle	SafeFileHandle クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	IsClosed	ハンドルが閉じているかどうかを示す値を取得します。(SafeHandle から継承されます。)
	IsInvalid	ハンドルが無効かどうかを示す値を取得します。(SafeHandleZeroOrMinusOneIsInvalid から継承されます。)

パブリック メソッド

	名前	説明
	Close	リソースを解放するためのハンドルをマークします。 (SafeHandle から継承されます。)
	DangerousAddRef	SafeHandle インスタンスの参照カウンタを手動でインクリメントします。 (SafeHandle から継承されます。)
	DangerousGetHandle	handle フィールドの値を返します。 (SafeHandle から継承されます。)
	DangerousRelease	SafeHandle インスタンスの参照カウンタを手動でデクリメントします。 (SafeHandle から継承されます。)
	Dispose	SafeHandle クラスによって使用されているすべてのリソースを解放します。 (SafeHandle から継承されます。)
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	SetHandleAsInvalid	今後は使用しないものとしてハンドルをマークします。 (SafeHandle から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

参照

関連項目

SafeFileHandle クラス
Microsoft.Win32.SafeHandles 名前空間
SafeHandle
SafeHandleZeroOrMinusOneIsInvalid