IOleInPlaceComponent.FDoIdle(UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop 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.

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

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

public:
 int FDoIdle(unsigned int grfidlef);

int FDoIdle(unsigned int grfidlef);

public int FDoIdle (uint grfidlef);

abstract member FDoIdle : uint32 -> int

Public Function FDoIdle (grfidlef As UInteger) As Integer

Parameters

grfidlef: UInt32

[in] Specifies the type of idle time processing to be performed.

Returns

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:

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.

Applies to

Share via