Share via


ICLRGCManager::GetStats Method

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

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 value to a bitmask of values that the runtime should return.

Requirements

Platforms: Windows 2000, Windows XP, Windows Server 2003 family

Header: MSCorEE.idl

Library: Included as a resource in MSCorEE.dll

.NET Framework Version: 2.0

See Also

Concepts

Automatic Memory Management

COR_GC_STATS Structure

Garbage Collection

Hosting the Common Language Runtime

ICLRControl Interface

ICLRGCManager Interface