GCHandle 構造体

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

GCHandle 構造体

アンマネージ メモリからマネージ オブジェクトにアクセスできるようにします。

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

Visual Basic (宣言)

<ComVisibleAttribute(True)> _
Public Structure GCHandle

Visual Basic (使用法)

Dim instance As GCHandle

C#

[ComVisibleAttribute(true)] 
public struct GCHandle

C++

[ComVisibleAttribute(true)] 
public value class GCHandle

J#

/** @attribute ComVisibleAttribute(true) */ 
public final class GCHandle extends ValueType

JScript

JScript では、構造体を使用できますが、新規に宣言することはできません。

解説

GCHandle クラスは、GCHandleType 列挙体と組み合わせて、任意のマネージ オブジェクトに対応するハンドルを作成するために使用します。このハンドルの種類は、Weak、WeakTrackResurrection、Normal、または Pinned のいずれかになります。いったん割り当てられた後は、GCHandle を使用することによって、アンマネージ クライアントが唯一の参照を保持しているときに、マネージ オブジェクトがガベージ コレクタによって収集されることを防ぐことができます。このようなハンドルがないと、オブジェクトが、アンマネージ クライアントの代わりとなって実行する処理を完了する前に、ガベージ コレクタによって収集される可能性があります。

また、GCHandle を使用して、メモリ アドレスを返す固定オブジェクトを作成し、ガベージ コレクタがオブジェクトをメモリから取り除くことを防ぐこともできます。

使用例

GCHandle.Alloc メソッドを使用してマネージ オブジェクトへのハンドルを作成する App クラスの例を次に示します。これによって、マネージ オブジェクトはガベージ コレクションの対象から除外されます。EnumWindows メソッドの呼び出しは、デリゲートとマネージ オブジェクト (両方ともマネージ型として宣言されていますが、ここでは示されていません) を渡し、ハンドルを IntPtr にキャストします。このアンマネージ関数は、コールバック関数のパラメータとして型を呼び出し元に戻します。

Visual Basic

Imports System
Imports System.IO
Imports System.Threading
Imports System.Windows.Forms
Imports System.Runtime.InteropServices
Imports System.Security.Permissions

Public Delegate Function
 CallBack(ByVal handle As Integer,
 ByVal param As IntPtr) As Boolean


Module LibWrap

    ' passing managed object as LPARAM
    ' BOOL EnumWindows(WNDENUMPROC lpEnumFunc, LPARAM lParam);
    <DllImport("user32.dll")> _
    Function EnumWindows(ByVal cb As
 CallBack, ByVal param As IntPtr) As
 Boolean
    End Function
End Module 'LibWrap


Module App

    Sub Main()
    Run()

    End Sub

    <SecurityPermission(SecurityAction.Demand, UnmanagedCode:=true)> _
    Sub Run()

        Dim tw As TextWriter = System.Console.Out
        Dim gch As GCHandle = GCHandle.Alloc(tw)

        Dim cewp As CallBack
        cewp = AddressOf CaptureEnumWindowsProc

        ' platform invoke will prevent delegate to be garbage collected
        ' before call ends
        LibWrap.EnumWindows(cewp, GCHandle.ToIntPtr(gch))
        gch.Free()

    End Sub


    Function CaptureEnumWindowsProc(ByVal handle
 As Integer, ByVal param
 As IntPtr) As Boolean
        Dim gch As GCHandle = GCHandle.FromIntPtr(param)
        Dim tw As TextWriter = CType(gch.Target,
 TextWriter)
        tw.WriteLine(handle)
        Return True

    End Function
End Module

C#

using System;
using System.IO;
using System.Threading;
using System.Windows.Forms;
using System.Runtime.InteropServices;
using System.Security.Permissions;

public delegate bool CallBack(int
 handle, IntPtr param);

public class LibWrap
{
    // passing managed object as LPARAM
    // BOOL EnumWindows(WNDENUMPROC lpEnumFunc, LPARAM lParam);

    [DllImport("user32.dll")]
    public static extern bool
 EnumWindows(CallBack cb, IntPtr param);
}

public class App
{
    public static void Main()
    {
        Run();
    }

        [SecurityPermission(SecurityAction.Demand, UnmanagedCode=true)]
    public static void Run()
        {
        TextWriter tw = System.Console.Out;
        GCHandle gch = GCHandle.Alloc(tw);

        CallBack cewp = new CallBack(CaptureEnumWindowsProc);

        // platform invoke will prevent delegate to be garbage collected
        // before call ends

        LibWrap.EnumWindows(cewp, GCHandle.ToIntPtr(gch));
        gch.Free();
        }

    private static bool
 CaptureEnumWindowsProc(int handle, IntPtr param)
    {
        GCHandle gch = GCHandle.FromIntPtr(param);
        TextWriter tw = (TextWriter)gch.Target;
        tw.WriteLine(handle);
        return true;
    }
}

スレッド セーフ

この型の 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 Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
GCHandle メンバ
System.Runtime.InteropServices 名前空間
GCHandleType