COR_HEAPINFO Structure

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

Syntax

typedef struct _COR_HEAPINFO {  
    BOOL areGCStructuresValid;   
    DWORD pointerSize;   
    DWORD numHeaps;  
    BOOL concurrent;   
    CorDebugGCType gcType;   
} COR_HEAPINFO;  

Members

Member Description
areGCStructuresValid true if garbage collection structures are valid and the heap can be enumerated; otherwise, false.
pointerSize The size, in bytes, of pointers on the target architecture.
numHeaps The number of logical garbage collection heaps in the process.
concurrent TRUE if concurrent (background) garbage collection is enabled; otherwise, FALSE.
gcType A member of the CorDebugGCType enumeration that indicates whether the garbage collector is running on a workstation or a server.

Remarks

An instance of the COR_HEAPINFO structure is returned by calling the ICorDebugProcess5::GetGCHeapInformation method.

Before enumerating objects on the garbage collection heap, you must always check the areGCStructuresValid field to ensure that the heap is in an enumerable state. For more information, see the ICorDebugProcess5::GetGCHeapInformation method.

Requirements

Platforms: See System Requirements.

Header: CorDebug.idl, CorDebug.h

Library: CorGuids.lib

.NET Framework Versions: Available since 4.5

See also