IDatabaseProjectWorkloadProvider.GetWorkload Method

Returns the workload left for this idle processor or returns zero if this processor has no workload left.

Namespace:  Microsoft.VisualStudio.Data.Schema.Package.Project
Assembly:  Microsoft.VisualStudio.Data.Schema.Package (in Microsoft.VisualStudio.Data.Schema.Package.dll)

Syntax

'Declaration
Sub GetWorkload ( _
    <OutAttribute> ByRef stepsLeftToPerform As Integer, _
    <OutAttribute> ByRef stepsProcessedForEachIdle As Integer, _
    <OutAttribute> ByRef workloadDescription As String _
)

void GetWorkload(
    out int stepsLeftToPerform,
    out int stepsProcessedForEachIdle,
    out string workloadDescription
)

void GetWorkload(
    [OutAttribute] int% stepsLeftToPerform, 
    [OutAttribute] int% stepsProcessedForEachIdle, 
    [OutAttribute] String^% workloadDescription
)

abstract GetWorkload : 
        stepsLeftToPerform:int byref * 
        stepsProcessedForEachIdle:int byref * 
        workloadDescription:string byref -> unit 

function GetWorkload(
    stepsLeftToPerform : int, 
    stepsProcessedForEachIdle : int, 
    workloadDescription : String
)

Parameters

• stepsLeftToPerform
  Type: System.Int32%
  The number of steps this idle processor must perform before its work is completed.

• stepsProcessedForEachIdle
  Type: System.Int32%
  The number of steps processed (on average) every time this idle processor is called. This indicates to the system how many more times to call OnIdle before all queued work has completed.

• workloadDescription
  Type: System.String%
  If workload remains, this returns the type of work to be performed. If enough work remains and the Visual Studio status bar is used, this text may be displayed to the user.

.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.

See Also

Reference

IDatabaseProjectWorkloadProvider Interface

Microsoft.VisualStudio.Data.Schema.Package.Project Namespace