SafeHandle

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

SafeHandle クラス

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

オペレーティング システム ハンドルのラッパー クラスを表します。

名前空間: System.Runtime.InteropServices
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public MustInherit Class
 SafeHandle
    Inherits CriticalFinalizerObject
    Implements IDisposable

Visual Basic (使用法)

Dim instance As SafeHandle

C#

public abstract class SafeHandle : CriticalFinalizerObject,
 IDisposable

C++

public ref class SafeHandle abstract : public
 CriticalFinalizerObject, IDisposable

J#

public abstract class SafeHandle extends CriticalFinalizerObject
 implements IDisposable

JScript

public abstract class SafeHandle extends
 CriticalFinalizerObject implements IDisposable

解説

SafeHandle クラスを使用すると、ハンドルのリサイクルによるセキュリティ攻撃から保護できます。また、このクラスはハンドル リソースの重大な終了処理も行います。このクラスを使用すると、派生クラスのインスタンスでラップされたアンマネージ リソースを識別するハンドル (オペレーティング システム ハンドルなど) をアンマネージ コードに渡すことができます。このクラスによって、ハンドルのリサイクルによるセキュリティ攻撃から保護できます。ハンドルのリサイクルの一例として、ハンドルの信頼関係のないユーザーが、あるスレッドのハンドルを閉じ、別のスレッドのリソースに対する操作をキューに配置しようとする場合が挙げられます。この信頼関係のないユーザーは、プロセス内の無関係なスレッドによってハンドルがすぐに再利用されることを期待してこれを実行します。また、インプロセス操作によって、呼び出し元が通常はアクセスできないデータが返されたり、変更されたりします。SafeHandle は、重大な終了処理も行います。ホストによって AppDomain がアンロードされた場合や、通常のファイナライザがブロックしたり、クリーンアップに時間がかかりすぎている場合でも、ReleaseHandle メソッドが実行されます。

汎用ハンドルを作成することはできないため、このクラスは抽象クラスです。SafeHandle を実装するには、オペレーティング システム ハンドルの型ごとに派生クラスを作成する必要があります。SafeHandle の派生クラスを作成するには、オペレーティング システム ハンドルを作成し、解放する方法を把握している必要があります。CloseHandle を使用する場合もあれば、UnmapViewOfFile や FindClose などの特定のメソッドを使用する場合もあるため、このプロセスはハンドルの型ごとに異なります。このため、オペレーティング システム ハンドルの型 (SafeRegistryHandle、SafeFileHandle、MySpecialSafeFileHandle など) ごとに、SafeHandle の派生クラスを作成する必要があります。これらの派生クラスの一部は、Microsoft.Win32.SafeHandles 名前空間にあらかじめ作成され提供されています。

メモ
SafeHandle から派生した独自のクラスの作成は高度なプログラミング技術です。SafeHandle から派生した作成済みの一連のクラスは、抽象派生クラスとして提供され、Microsoft.Win32.SafeHandles 名前空間にあります。これらのクラスは、ファイル ハンドルとオペレーティング システム ハンドルをサポートする共通機能を提供するように設計されています。

継承時の注意 SafeHandle から継承する場合は、IsInvalid および ReleaseHandle の両メンバをオーバーライドする必要があります。 また、無効なハンドル値を表す値と、マネージ コードでネイティブ ハンドルを所有するかどうかを示すブール値を持つ、基本コンストラクタを呼び出す既定のコンストラクタを提供することも必要です。

使用例

SafeHandle クラスを実装する方法を次のコード例に示します。

C#

using System;
using System.Runtime.InteropServices;
using System.Runtime.CompilerServices;
using System.Runtime.ConstrainedExecution;

namespace SafeHandleExample
{
    sealed class MySafeHandleSubclass : SafeHandle
    {
        // Called by P/Invoke when returning SafeHandles
        private MySafeHandleSubclass()
            : base(IntPtr.Zero, true)
        {
        }
        // If & only if you need to support user-supplied handles
        internal MySafeHandleSubclass(IntPtr preexistingHandle, bool
 ownsHandle)
            : base(IntPtr.Zero, ownsHandle)
        {
            SetHandle(preexistingHandle);
        }
        // Do not provide a finalizer - SafeHandle's critical finalizer
 will
        // call ReleaseHandle for you.
        public override bool IsInvalid
        {

            get { return IsClosed || handle
 == IntPtr.Zero; }
        }
        [DllImport("kernel32")]
        [ReliabilityContract(Consistency.WillNotCorruptState, Cer.Success)]
        private static extern bool
 CloseHandle(IntPtr handle);

        protected override bool ReleaseHandle()
        {
            return CloseHandle(handle);
        }
        [DllImport("kernel32")]
        public static extern MySafeHandleSubclass
 CreateHandle(int someState);
    }
    class Class1
    {

        [STAThread]
        static void Main(string[]
 args)
        {
            bool ownsHandle = true;
            MySafeHandleSubclass s = new MySafeHandleSubclass(IntPtr.Zero,
 ownsHandle);
        }
    }
}

.NET Framework のセキュリティ

• SecurityPermission  (アンマネージ コードを操作するために必要なアクセス許可)UnmanagedCode (関連する列挙体)

継承階層

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

スレッド セーフ

この型の 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

参照

関連項目
SafeHandle メンバ
System.Runtime.InteropServices 名前空間
Microsoft.Win32.SafeHandles
CriticalHandle クラス
CriticalFinalizerObject クラス

SafeHandle クラス

名前空間: System.Security.Cryptography
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public MustInherit Class
 SafeHandle
    Implements IDisposable

Visual Basic (使用法)

Dim instance As SafeHandle

C#

public abstract class SafeHandle : IDisposable

C++

public ref class SafeHandle abstract : IDisposable

J#

public abstract class SafeHandle implements
 IDisposable

JScript

public abstract class SafeHandle implements
 IDisposable

継承階層

System.Object
   System.Security.Cryptography.RandomNumberGenerator
    System.Security.Cryptography.SafeHandle

スレッド セーフ

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

バージョン情報

.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
SafeHandle メンバ
System.Security.Cryptography 名前空間

SafeHandle コンストラクタ

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

指定した無効なハンドル値を使用して、SafeHandle クラスの新しいインスタンスを初期化します。

名前空間: System.Runtime.InteropServices
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Protected Sub New ( _
    invalidHandleValue As IntPtr, _
    ownsHandle As Boolean _
)

Visual Basic (使用法)

Dim invalidHandleValue As IntPtr
Dim ownsHandle As Boolean

Dim instance As New SafeHandle(invalidHandleValue,
 ownsHandle)

C#

protected SafeHandle (
    IntPtr invalidHandleValue,
    bool ownsHandle
)

C++

protected:
SafeHandle (
    IntPtr invalidHandleValue, 
    bool ownsHandle
)

J#

protected SafeHandle (
    IntPtr invalidHandleValue, 
    boolean ownsHandle
)

JScript

protected function SafeHandle (
    invalidHandleValue : IntPtr, 
    ownsHandle : boolean
)

パラメータ

invalidHandleValue

無効なハンドルの値 (通常は 0 または -1)。IsInvalid の実装では、この値に対して true を返す必要があります。

ownsHandle

終了処理中に SafeHandle によってハンドルを確実に解放する場合は true。それ以外の場合は false (お勧めしません)。

例外

例外の種類	条件
TypeLoadException	派生クラスがアンマネージ コードのアクセス許可なしにアセンブリに存在しています。

解説

ownsHandle パラメータが false の場合、ReleaseHandle が呼び出されることはありません。したがって、コードがリソースをリークする可能性があるため、このパラメータ値を使用することはお勧めしません。

.NET Framework のセキュリティ

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

プラットフォーム

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

参照

関連項目
SafeHandle クラス
SafeHandle メンバ
System.Runtime.InteropServices 名前空間

SafeHandle コンストラクタ

名前空間: System.Security.Cryptography
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Protected Sub New ( _
    invalidHandleValue As IntPtr, _
    ownsHandle As Boolean _
)

Visual Basic (使用法)

Dim invalidHandleValue As IntPtr
Dim ownsHandle As Boolean

Dim instance As New SafeHandle(invalidHandleValue,
 ownsHandle)

C#

protected SafeHandle (
    IntPtr invalidHandleValue,
    bool ownsHandle
)

C++

protected:
SafeHandle (
    IntPtr invalidHandleValue, 
    bool ownsHandle
)

J#

protected SafeHandle (
    IntPtr invalidHandleValue, 
    boolean ownsHandle
)

JScript

protected function SafeHandle (
    invalidHandleValue : IntPtr, 
    ownsHandle : boolean
)

パラメータ

invalidHandleValue

ownsHandle

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

バージョン情報

.NET Compact Framework

サポート対象 : 2.0

参照

関連項目

SafeHandle クラス
SafeHandle メンバ
System.Security.Cryptography 名前空間

SafeHandle フィールド

プロテクト フィールド

	名前	説明
	handle	ラップするハンドルを指定します。

参照

関連項目

SafeHandle クラス
System.Runtime.InteropServices 名前空間
Microsoft.Win32.SafeHandles
CriticalHandle クラス
CriticalFinalizerObject クラス

SafeHandle フィールド

プロテクト フィールド

	名前	説明
	handle

参照

関連項目

SafeHandle クラス
System.Security.Cryptography 名前空間

SafeHandle プロパティ

パブリック プロパティ

	名前	説明
	IsClosed	ハンドルが閉じているかどうかを示す値を取得します。
	IsInvalid	派生クラスでオーバーライドされると、ハンドル値が無効かどうかを示す値を取得します。

参照

関連項目

SafeHandle クラス
System.Runtime.InteropServices 名前空間
Microsoft.Win32.SafeHandles
CriticalHandle クラス
CriticalFinalizerObject クラス

SafeHandle プロパティ

パブリック プロパティ

	名前	説明
	IsInvalid

参照

関連項目

SafeHandle クラス
System.Security.Cryptography 名前空間

SafeHandle メソッド

パブリック メソッド

( プロテクト メソッド も参照)

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

プロテクト メソッド

	名前	説明
	Dispose	オーバーロードされます。 SafeHandle クラスが使用しているリソースを解放します。
	Finalize	オーバーライドされます。 ハンドルに関連付けられたすべてのリソースを解放します。
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)
	ReleaseHandle	派生クラスでオーバーライドされると、ハンドルを解放するために必要なコードを実行します。
	SetHandle	ハンドルを指定した既存のハンドルに設定します。

参照

関連項目

SafeHandle クラス
System.Runtime.InteropServices 名前空間
Microsoft.Win32.SafeHandles
CriticalHandle クラス
CriticalFinalizerObject クラス

SafeHandle メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	オーバーライドされます。
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)
	SetHandle

参照

関連項目

SafeHandle クラス
System.Security.Cryptography 名前空間

SafeHandle メンバ

オペレーティング システム ハンドルのラッパー クラスを表します。

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

プロテクト コンストラクタ

	名前	説明
	SafeHandle	指定した無効なハンドル値を使用して、SafeHandle クラスの新しいインスタンスを初期化します。

プロテクト フィールド

	名前	説明
	handle	ラップするハンドルを指定します。

パブリック プロパティ

	名前	説明
	IsClosed	ハンドルが閉じているかどうかを示す値を取得します。
	IsInvalid	派生クラスでオーバーライドされると、ハンドル値が無効かどうかを示す値を取得します。

パブリック メソッド

( プロテクト メソッド も参照)

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

プロテクト メソッド

	名前	説明
	Dispose	オーバーロードされます。 SafeHandle クラスが使用しているリソースを解放します。
	Finalize	オーバーライドされます。 ハンドルに関連付けられたすべてのリソースを解放します。
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	ReleaseHandle	派生クラスでオーバーライドされると、ハンドルを解放するために必要なコードを実行します。
	SetHandle	ハンドルを指定した既存のハンドルに設定します。

参照

関連項目

SafeHandle クラス
System.Runtime.InteropServices 名前空間
Microsoft.Win32.SafeHandles
CriticalHandle クラス
CriticalFinalizerObject クラス

SafeHandle メンバ

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

プロテクト コンストラクタ

	名前	説明
	SafeHandle

プロテクト フィールド

	名前	説明
	handle

パブリック プロパティ

	名前	説明
	IsInvalid

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	オーバーライドされます。
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	SetHandle

参照

関連項目

SafeHandle クラス
System.Security.Cryptography 名前空間