ICLRTask::YieldTask メソッド

2011-08-09

現在の ICLRTask インスタンスが表すタスクを一時中断して、他のタスクがプロセッサ時間を使用できるようにするよう、共通言語ランタイム (CLR: Common Language Runtime) に要求します。

HRESULT YieldTask ();

戻り値

HRESULT	説明
S_OK	YieldTask が正常に終了しました。
HOST_E_CLRNOTAVAILABLE	CLR がプロセスに読み込まれていません。または、CLR がマネージコードを実行できない状態か、呼び出しを正常に処理できない状態にあります。
HOST_E_TIMEOUT	呼び出しがタイムアウトしました。
HOST_E_NOT_OWNER	呼び出し元がロックを所有していません。
HOST_E_ABANDONED	ブロックされたスレッドまたはファイバーが待機しているイベントがキャンセルされました。
E_FAIL	未知の重大エラーが発生しました。メソッドから E_FAIL が返される場合、プロセス内で CLR を使用することはできません。ホストメソッドへの後続の呼び出しは、HOST_E_CLRNOTAVAILABLE を返します。

解説

ホストは YieldTask を呼び出して、他のタスクまたはプロセスのプロセッサリソースを要求します。このメソッドの主な目的は、長時間実行するコードが CPU 時間を引き渡せるようにすることです。ランタイムは現在の ICLRTask インスタンスが表すタスクを一時停止して、他のタスクの処理時間を確保できるように試みますが、この操作を確実に行うことができるという保証はありません。