ICLRGCManager::GetStats Method

  • Article

Gets a set of current statistics about the common language runtime's garbage collection system.

Syntax

HRESULT GetStats (  
    [in, out] COR_GC_STATS *pStats  
);

Parameters

pStats
[in, out] A COR_GC_STATS instance that contains the requested statistics.

Return Value

HRESULT Description
S_OK GetStats returned successfully.
HOST_E_CLRNOTAVAILABLE The common language runtime (CLR) has not been loaded into a process, or the CLR is in a state in which it cannot run managed code or process the call successfully.
HOST_E_TIMEOUT The call timed out.
HOST_E_NOT_OWNER The caller does not own the lock.
HOST_E_ABANDONED An event was canceled while a blocked thread or fiber was waiting on it.
E_FAIL An unknown catastrophic failure occurred. After a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.

Remarks

The CLR calculates and returns only those statistics that are specified by the Flags field of pStats.

Set the Flags field to one or more values of the COR_GC_STAT_TYPES enumeration to specify which statistics in the COR_GC_STATS structure are to be set.

An example of the usage is as follows:

COR_GC_STATS GCStats;  
GCStats.Flags = COR_GC_COUNTS | COR_GC_MEMORYUSAGE;  
pCLRGCManager->GetStats(&GCStats);

Requirements

Platforms: See System Requirements.

Header: MSCorEE.h

Library: Included as a resource in MSCorEE.dll

.NET Framework Versions: Available since 2.0

See also