ICLRGCManager::Collect Method

Forces a garbage collection for the specified generation.

HRESULT Collect (
    [in] LONG Generation
);

Parameters

Generation
[in] The generation to collect. A value of -1 forces a collection of all generations.

HRESULT	Description
S_OK	Collect 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.

The Collect method forces the CLR's garbage collector to perform a collection regardless of its current state.

Platforms: See .NET Framework System Requirements.

Header: MSCorEE.idl

Library: Included as a resource in MSCorEE.dll

.NET Framework Versions: 3.5 SP1, 3.5, 3.0 SP1, 3.0, 2.0 SP1, 2.0