SingleTaskIdleManager.IOleComponent.FDoIdle Method

Article
04/29/2015

Gives the component a chance to do idle time tasks.

Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)

Syntax

'Declaration
Private Function FDoIdle ( _
    grfidlef As UInteger _
) As Integer Implements IOleComponent.FDoIdle

int IOleComponent.FDoIdle(
    uint grfidlef
)

private:
virtual int FDoIdle(
    unsigned int grfidlef
) sealed = IOleComponent::FDoIdle

private abstract FDoIdle : 
        grfidlef:uint32 -> int  
private override FDoIdle : 
        grfidlef:uint32 -> int

JScript does not support explicit interface implementations.

Parameters

grfidlef
Type: UInt32

A set of flags indicating the type of idle tasks to perform, from _OLEIDLEF.

Return Value

Type: Int32
true if more time is needed to perform the idle time tasks, false otherwise.

Implements

IOleComponent.FDoIdle(UInt32)

Remarks

The component may periodically call FContinueIdle; if this method returns false, the component should terminate its idle time processing and return.

If a component reaches a point where it has no idle tasks and does not need FDoIdle calls, it should remove its idle task registration via FUpdateComponentRegistration.

If this method is called while the component is performing a tracking operation, the component should perform only those idle time tasks that are appropriate during tracking.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via