OleComponent.IOleComponent.FDoIdle(UInt32) Method

Definition

Namespace:

Microsoft.VisualStudio.PlatformUI.OleComponentSupport

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Called to give a component a chance to do idle time tasks. Component may periodically call FContinueIdle(); if this method returns FALSE (0), component should terminate its idle time processing and return. Simply calls through to FDoIdleCore(UInt32).

 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 group of bit flags that indicate what type of tasks to perform (maps directly to IdleTypes.

Returns

Int32

TRUE (1) if more time is needed to perform the idle time tasks, FALSE (0) otherwise.

Implements

FDoIdle(UInt32)

Remarks

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(UInt32, OLECRINFO[]). If this method is called on while component is performing a tracking operation, component should only perform idle time tasks that it deems are appropriate to perform during tracking.