Edit

Share via

ICorDebugProcess5::GetGCHeapInformation Method

  • Article

Provides general information about the garbage collection heap, including whether it is currently enumerable.

Syntax

HRESULT GetGCHeapInformation(
    [out] COR_HEAPINFO *pHeapInfo
);

Parameters

pHeapInfo [out] A pointer to a COR_HEAPINFO value that provides general information about the garbage collection heap.

Remarks

The ICorDebugProcess5::GetGCHeapInformation method must be called before enumerating the heap or individual heap regions to ensure that the garbage collection structures in the process are currently valid. The garbage collection heap cannot be walked while a collection is in progress. Otherwise, the enumeration may capture garbage collection structures that are invalid.

Requirements

Platforms: See System Requirements.

Header: CorDebug.idl, CorDebug.h

Library: CorGuids.lib

.NET Framework Versions: Available since 4.5

See also