Edit

Share via

IHostAutoEvent::Wait Method

  • Article

Causes the current IHostAutoEvent instance to wait until it is owned or a specified amount of time elapses.

Syntax

HRESULT Wait (  
    [in] DWORD dwMilliseconds,  
    [in] DWORD option  
);

Parameters

dwMilliseconds
[in] The number of milliseconds the current IHostAutoEvent instance should wait before returning, if no thread or fiber takes ownership.

option
[in] One of the WAIT_OPTION values, specifying the action the host should take if this operation blocks.

Return Value

HRESULT Description
S_OK Wait 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.
HOST_E_DEADLOCK The host detected a deadlock during the wait interval, and chose the event represented by the current IHostAutoEvent instance as the deadlock victim.

Requirements

Platforms: See System Requirements.

Header: MSCorEE.h

Library: Included as a resource in MSCorEE.dll

.NET Framework Versions: Available since 2.0

See also