IOpLockStatus::GetOplockEventHandle method (searchapi.h)

Gets the event handle of the opportunistic lock (OpLock). The event object is set to the signaled state when the OpLock is broken, enabling the indexer to stop all operations on the underlying IUrlAccessor object.

Syntax

HRESULT GetOplockEventHandle(
  [out] HANDLE *phOplockEv
);

Parameters

[out] phOplockEv

Type: HANDLE*

Receives a pointer to the handle of the event associated with the OpLock, or NULL if no OpLock was taken.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	searchapi.h
Redistributable	Windows Desktop Search (WDS) 3.0