SimpleEditorView.FDoIdle(UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Package

Assembly:: Microsoft.VisualStudio.Package.LanguageService.14.0.dll

Assembly:: Microsoft.VisualStudio.Package.LanguageService.15.0.dll

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.

Called to do idle time tasks.

public:
 virtual int FDoIdle(System::UInt32 grfidlef);

public:
 virtual int FDoIdle(unsigned int grfidlef);

 virtual int FDoIdle(unsigned int grfidlef);

public virtual int FDoIdle (uint grfidlef);

abstract member FDoIdle : uint32 -> int
override this.FDoIdle : uint32 -> int

Public Overridable Function FDoIdle (grfidlef As UInteger) As Integer

Parameters

grfidlef: UInt32

Flags from the _OLEIDLEF enumeration.

Returns

Int32

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

Implements

FDoIdle(UInt32)

Remarks

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

Notes to Inheritors

grfidlef indicates the type of idle tasks to perform. The method Microsoft.VisualStudio.OLE.Interop.IOleComponentManager.FContinueIdle() will be called from time to time. If this method returns false, idle-time processing must terminate and return. If there are no idle tasks, idle task registration must be removed via Microsoft.VisualStudio.OLE.Interop.IOleComponentManager::FUpdateComponentRegistration. If this method is called during a tracking operation, only idle time tasks that are appropriate during tracking should be performed.

Applies to