IHostGCManager::SuspensionStarting Method

Notifies the host that the common language runtime (CLR) is suspending execution of tasks, to perform a garbage collection.

HRESULT SuspensionStarting ();

Return Value

HRESULT	Description
S_OK	SuspensionStarting returned successfully.
HOST_E_CLRNOTAVAILABLE	The 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. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.

The CLR calls SuspensionStarting to inform the host that garbage collection is occurring.

Important
Do not reschedule this task. The host must reschedule a task when ThreadIsBlockingForSuspension is called.

Platforms: See .NET Framework System Requirements.

Header: MSCorEE.h

Library: Included as a resource in MSCorEE.dll

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