IOleInPlaceComponent.FDoIdle Method

Artikel
02/23/2010

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

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Function FDoIdle ( _
    grfidlef As UInteger _
) As Integer
'Usage
Dim instance As IOleInPlaceComponent
Dim grfidlef As UInteger
Dim returnValue As Integer

returnValue = instance.FDoIdle(grfidlef)

int FDoIdle(
    uint grfidlef
)

int FDoIdle(
    [InAttribute] unsigned int grfidlef
)

abstract FDoIdle : 
        grfidlef:uint32 -> int

function FDoIdle(
    grfidlef : uint
) : int

Parameters

grfidlef
Type: System.UInt32
[in] Specifies the type of idle time processing to be performed.

Return Value

Type: System.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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Freigeben über