IOleComponent.FDoIdle Method

Gives the component a chance to do idle time tasks.

Namespace:  Microsoft.VisualStudio.OLE.Interop
Assembly:  Microsoft.VisualStudio.OLE.Interop (in Microsoft.VisualStudio.OLE.Interop.dll)

Syntax

'Declaration
Function FDoIdle ( _
    grfidlef As UInteger _
) As Integer
int FDoIdle(
    uint grfidlef
)
int FDoIdle(
    [InAttribute] unsigned int grfidlef
)
abstract FDoIdle : 
        grfidlef:uint32 -> int
function FDoIdle(
    grfidlef : uint
) : int

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.

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

See Also

Reference

IOleComponent Interface

Microsoft.VisualStudio.OLE.Interop Namespace