GCHandle Структура

Определение

Пространство имен:

System.Runtime.InteropServices

Сборка:

System.Runtime.dll

Исходный код:

GCHandle.cs

Предоставляет способ доступа к управляемому объекту из неуправляемой памяти.

public value class GCHandle : IEquatable<System::Runtime::InteropServices::GCHandle>

public struct GCHandle : IEquatable<System.Runtime.InteropServices.GCHandle>

type GCHandle = struct

Public Structure GCHandle
Implements IEquatable(Of GCHandle)

Наследование

Object

ValueType

GCHandle

Реализации

IEquatable<GCHandle>

Примеры

В следующем примере показан App класс, который создает дескриптор для управляемого объекта с помощью GCHandle.Alloc метода , который предотвращает сбор управляемого объекта. Вызов EnumWindows метода передает делегат и управляемый объект (оба объявлены как управляемые типы, но не показаны) и приводит дескриптор к IntPtr. Неуправляемая функция передает тип обратно вызывающей стороне в качестве параметра функции обратного вызова.

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

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

internal static class NativeMethods
{
    // passing managed object as LPARAM
    // BOOL EnumWindows(WNDENUMPROC lpEnumFunc, LPARAM lParam);

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

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

    public static void Run()
    {
        TextWriter tw = Console.Out;
        GCHandle gch = GCHandle.Alloc(tw);

        CallBack cewp = new CallBack(CaptureEnumWindowsProc);

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

        NativeMethods.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;
    }
}

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


Friend Module NativeMethods

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


Module App

    Sub Main()

        Run()

    End Sub

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

        Dim tw As TextWriter = 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
        NativeMethods.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

Комментарии

Структура GCHandle используется с перечислением GCHandleType для создания дескриптора, соответствующего любому управляемому объекту. Этот дескриптор может быть одного из четырех типов: Weak, WeakTrackResurrection, Normalили Pinned. После выделения дескриптора его можно использовать для предотвращения сбора управляемого объекта сборщиком мусора, если неуправляемый клиент содержит единственную ссылку. Без такого дескриптора сборщик мусора может собрать объект до завершения работы от имени неуправляемого клиента.

Можно также использовать для GCHandle создания закрепленного объекта, который возвращает адрес памяти, чтобы предотвратить перемещение объекта в памяти сборщиком мусора.

Когда дескриптор выходит за пределы области, его необходимо явно освободить, вызвав Free метод ; в противном случае могут возникнуть утечки памяти. При освобождении закрепленного дескриптора связанный объект будет откреплен и получит право на сборку мусора, если на него нет других ссылок.

Свойства

IsAllocated	Возвращает значение, показывающее, выделен ли дескриптор.
Target	Возвращает или задает объект, предоставляемый дескриптором.

Методы

AddrOfPinnedObject()	Получает адрес данных объекта в маркере Pinned.
Alloc(Object)	Выделяет дескриптор Normal для указанного объекта.
Alloc(Object, GCHandleType)	Выделяет дескриптор указанного типа для указанного объекта.
Equals(GCHandle)	Указывает, равен ли текущий экземпляр другому экземпляру того же типа.
Equals(Object)	Определяет, равен ли заданный объект GCHandle текущему объекту GCHandle.
Free()	Освобождает дескриптор GCHandle.
FromIntPtr(IntPtr)	Возвращает новый объект GCHandle, созданный из дескриптора управляемого объекта.
GetHashCode()	Возвращает идентификатор текущего объекта GCHandle.
ToIntPtr(GCHandle)	Возвращает внутреннее целочисленное представление объекта GCHandle.

Операторы

Equality(GCHandle, GCHandle)	Возвращает значение, показывающее, равны ли два объекта GCHandle.
Explicit(GCHandle to IntPtr)	Дескриптор GCHandle хранится в виде целого числа как внутреннего представления.
Explicit(IntPtr to GCHandle)	Дескриптор GCHandle хранится в виде целого числа как внутреннего представления.
Inequality(GCHandle, GCHandle)	Возвращает значение, показывающее, являются ли два объекта GCHandle неравными.

См. также раздел

• GCHandleType