Edit

Share via

IOpLockStatus interface (searchapi.h)

  • Article

Provides methods to check the opportunistic lock that is used by Microsoft Windows Desktop Search (WDS) on items while indexing. If another process locks the file in an incompatible manner, WDS will lose its lock and allow the other process to have the file. This mechanism allows WDS to run in the background. Consequently, WDS needs to check its locks to ensure another process has not taken precedence while WDS indexes the item.

A third-party IUrlAccessor object can implement this interface if the underlying data store provides a mechanism to track concurrent access to items. If this interface is exposed by IUrlAccessor, WDS will check the IOpLockStatus while indexing items from that store.

Inheritance

The IOpLockStatus interface inherits from the IUnknown interface. IOpLockStatus also has these types of members:

Methods

The IOpLockStatus interface has these methods.

 
IOpLockStatus::GetOplockEventHandle

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.
IOpLockStatus::IsOplockBroken

Checks the status of the opportunistic lock (OpLock) on the item being indexed. (IOpLockStatus.IsOplockBroken)
IOpLockStatus::IsOplockValid

Checks the status of the opportunistic lock (OpLock) on the item being indexed. (IOpLockStatus.IsOplockValid)

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