ISearchProtocolThreadContext::ThreadIdle method (searchapi.h)

Notifies the protocol handler that the filtering thread is idle, so that the protocol handler can clean up any cache it might have built up.

Syntax

HRESULT ThreadIdle(
  [in] DWORD dwTimeElaspedSinceLastCallInMS
);

Parameters

[in] dwTimeElaspedSinceLastCallInMS

Type: DWORD

Passes the idle time, in milliseconds, to the protocol handler.

Return value

Type: HRESULT

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

Remarks

This method is called when the filtering thread is waiting for new requests from the indexer service so the protocol handler can use this idle time to clean up.

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