DataSchemaErrorTaskService.GetWorkload Method
Returns the workload that remains for this idle processor.
Namespace: Microsoft.VisualStudio.Data.Schema.Package.UI
Assembly: Microsoft.VisualStudio.Data.Schema.Package (in Microsoft.VisualStudio.Data.Schema.Package.dll)
Syntax
'Declaration
Public Sub GetWorkload ( _
<OutAttribute> ByRef stepsLeftToPerform As Integer, _
<OutAttribute> ByRef stepsProcessedForEachIdle As Integer, _
<OutAttribute> ByRef workloadDescription As String _
)
public void GetWorkload(
out int stepsLeftToPerform,
out int stepsProcessedForEachIdle,
out string workloadDescription
)
public:
virtual void GetWorkload(
[OutAttribute] int% stepsLeftToPerform,
[OutAttribute] int% stepsProcessedForEachIdle,
[OutAttribute] String^% workloadDescription
) sealed
abstract GetWorkload :
stepsLeftToPerform:int byref *
stepsProcessedForEachIdle:int byref *
workloadDescription:string byref -> unit
override GetWorkload :
stepsLeftToPerform:int byref *
stepsProcessedForEachIdle:int byref *
workloadDescription:string byref -> unit
public final function GetWorkload(
stepsLeftToPerform : int,
stepsProcessedForEachIdle : int,
workloadDescription : String
)
Parameters
- stepsLeftToPerform
Type: System.Int32%
The number of steps that this idle processor must still 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 OnIdle must be called before all queued work has completed.
- workloadDescription
Type: System.String%
If any workload remains, this returns the type of work to be performed. If enough work remains and the status bar is used, this text may be displayed to the user.
Implements
IDatabaseProjectWorkloadProvider.GetWorkload(Int32%, Int32%, String%)
Remarks
If this processor does not have any workload left, it returns 0.
.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.