EditorControl::FDoIdle Method (UInt32)

Visual Studio 2015

Gives the component a chance to do idle time tasks.

Namespace: Microsoft.VisualStudio.Package
Assembly: Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

Syntax

C++

public:
virtual int FDoIdle(
	unsigned int grfidlef
) override

Parameters

grfidlef: Type: System::UInt32
Flags from the _OLEIDLEF enumeration.

Return Value

Type: System::Int32

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

Implements

IOleComponent::FDoIdle(UInt32)

Remarks

By default this method is not implemented, and simply returns false.

Notes to Implementers:

grfidlef indicates the type of idle tasks to perform. The component may periodically call M:Microsoft.VisualStudio.OLE.Interop.IOleComponentManager.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 M:Microsoft.VisualStudio.OLE.Interop.IOleComponentManager::FUpdateComponentRegistration. If this method is called while the component is performing a tracking operation, the component should perform only those idle time tasks that it deems appropriate to perform during tracking.