IHostSyncManager::CreateRWLockReaderEvent Method

Creates a manual-reset event object for the implementation of a reader lock.

HRESULT CreateRWLockReaderEvent (
    [in]  BOOL bInitialState,
    [in]  SIZE_T cookie,
    [out] IHostManualEvent **ppEvent
);

Parameters

  • bInitialState
    [in] true, if ppEvent should be signaled; otherwise, false.

  • cookie
    [in] A cookie to associate with the reader lock.

  • ppEvent
    [out] A pointer to the address of an IHostManualEvent instance, or null if the event object could not be created.

Return Value

HRESULT

Description

S_OK

CreateRWLockReaderEvent 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.

E_OUTOFMEMORY

Not enough memory was available to create the requested event object.

Remarks

The CLR calls CreateRWLockReaderEvent to get a reference to an IHostManualEvent instance to use in its implementation of a reader lock. The host can use the cookie to determine which tasks are waiting on the reader lock by querying the ICLRSyncManager interface.

Requirements

Platforms: Windows 2000, Windows XP, Windows Server 2003 family

Header: MSCorEE.idl

Library: Included as a resource in MSCorEE.dll

.NET Framework Version: 2.0

See Also

Concepts

ICLRSyncManager Interface

IHostAutoEvent Interface

IHostManualEvent Interface

IHostSyncManager Interface