IOleInPlaceComponent::FDoIdle Method (UInt32)

Visual Studio 2015

Queries an in-place VSPackage about its need to perform idle time tasks.

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

Syntax

C++

int FDoIdle(
	unsigned int grfidlef
)

Parameters

grfidlef: Type: System::UInt32
[in] Specifies the type of idle time processing to be performed.

Return Value

Type: System::Int32

The method returns true if the in-place object needs more time to perform idle time tasks and false if no additional idle time is needed.

Remarks

COM Signature

From oleipc.idl:

C++

BOOL IOleInPlaceComponent::FDoIdle(
   [in] DWORD grfidlef
);

The FDoIdle method is similar to the FDoIdle method.

The environment controls which type of idle tasks the object performs. It can direct the object to perform either the periodic (timer-based) idle tasks or all idle tasks.

The in-place object is expected to periodically call the FContinueIdle method to determine when it is time to terminate its idle time tasks.