SingleTaskIdleManager.IOleComponent.FDoIdle(UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gives the component a chance to do idle time tasks.

 virtual int Microsoft.VisualStudio.OLE.Interop.IOleComponent.FDoIdle(System::UInt32 grfidlef) = Microsoft::VisualStudio::OLE::Interop::IOleComponent::FDoIdle;

 virtual int Microsoft.VisualStudio.OLE.Interop.IOleComponent.FDoIdle(unsigned int grfidlef) = Microsoft::VisualStudio::OLE::Interop::IOleComponent::FDoIdle;

int Microsoft.VisualStudio.OLE.Interop.IOleComponent.FDoIdle(unsigned int grfidlef);

int IOleComponent.FDoIdle (uint grfidlef);

abstract member Microsoft.VisualStudio.OLE.Interop.IOleComponent.FDoIdle : uint32 -> int
override this.Microsoft.VisualStudio.OLE.Interop.IOleComponent.FDoIdle : uint32 -> int

Function FDoIdle (grfidlef As UInteger) As Integer Implements IOleComponent.FDoIdle

Parameters

grfidlef: UInt32

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

Returns

Int32

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

Implements

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.

Applies to

Share via