IXPLogon::Idle

Applies to: Outlook 2013 | Outlook 2016

Indicates that the system is idle, enabling the transport provider to perform low-priority operations.

HRESULT Idle(
  ULONG ulFlags
);

Parameters

ulFlags

[in] Reserved; must be zero.

Return value

S_OK

The call succeeded and returned the expected value or values.

Remarks

The MAPI spooler periodically calls the IXPLogon::Idle method, if requested, during times when the system is idle by passing the XP_LOGON_SP flag in the call to the IXPProvider::TransportLogon method that opened the current session. At times when the system is idle, the transport provider can perform background operations that are not appropriate during other calls, or that need to occur on a regular basis.

See also

IXPProvider::TransportLogon

IXPLogon : IUnknown