IHostTask::Alert Method
Requests that the host wake the task represented by the current IHostTask instance, so the task can be aborted.
HRESULT Alert ();
Return Value
HRESULT |
Description |
|---|---|
S_OK |
The method 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. When 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 calls the Alert method when Thread.Abort is called from user code, or when the AppDomain associated with the current Thread shuts down. The host must return immediately, because the call is made asynchronously. If the host cannot alert the task immediately, it must wake up the next time it enters a state in which it can be alerted.
Note
Alert affects only those tasks to which the runtime has passed a WAIT_OPTION value of WAIT_ALERTABLE to methods such as Join.
Requirements
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