ICLRTask::YieldTask Method

 

Requests that the common language runtime (CLR) put aside the task that the current ICLRTask instance represents, and make the processor time available to other tasks.

HRESULT YieldTask ();  

HRESULTDescription
S_OKYieldTask returned successfully.
HOST_E_CLRNOTAVAILABLEThe 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_TIMEOUTThe call timed out.
HOST_E_NOT_OWNERThe caller does not own the lock.
HOST_E_ABANDONEDAn event was canceled while a blocked thread or fiber was waiting on it.
E_FAILAn 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.

A host calls YieldTask to request processor resources for other tasks or processes. This method is primarily intended to allow long-running code to give up CPU time. The runtime attempts to put the task that the current ICLRTask instance represents in a state where it can yield processing time, but makes no guarantee of success.

Platforms: See System Requirements.

Header: MSCorEE.h

Library: Included as a resource in MSCorEE.dll

.NET Framework Versions: Available since 2.0

ICLRTask Interface
ICLRTaskManager Interface
IHostTask Interface
IHostTaskManager Interface

Show: