Share via

IIdle

  • Article

This provider-specific interface exists under the Session cotype in the OLE DB Provider for Microsoft Jet. The Session cotype is defined in Appendix D of the OLE DB Programmer's Reference, "Cotypes, Structures, and Enumerated Types."

When to Implement

IIdle is implemented only for the OLE DB Provider for Microsoft Jet.

Method

Description

Idle

Performs idle time database operations.

IIdle::Idle

Performs database cleanup and optimizations while waiting for user input.

Syntax

HRESULT IIdle::Idle(
   ULONG   dwFlags);

Parameters

  • dwFlags
    [in] Option flags for idle time processing. This parameter should be passed as zero.

Return Code

  • S_OK
    The method succeeded.

  • E_INVALIDARG
    Invalid flags specified.

  • E_FAIL
    An error occurred during idle processing.

Comments

When waiting for user input, Idle is called so that the engine can perform periodic cleanup and optimization tasks. Such tasks include background query execution, page timeout, memory cleanup, and so on.