SPCmdlet.WriteProgress Method (String, String, Int32)

  • Article

Writes progress information to the screen regarding the executing cmdlet.

Namespace:  Microsoft.SharePoint.PowerShell
Assembly:  Microsoft.SharePoint.PowerShell (in Microsoft.SharePoint.PowerShell.dll)

Syntax

'Declaration
Protected Sub WriteProgress ( _
    activity As String, _
    statusDescription As String, _
    percentCompleted As Integer _
)
'Usage
Dim activity As String
Dim statusDescription As String
Dim percentCompleted As Integer

Me.WriteProgress(activity, statusDescription, _
    percentCompleted)

protected void WriteProgress(
    string activity,
    string statusDescription,
    int percentCompleted
)

Parameters

  • activity
    Type: System.String

    Indicates the action performed by the specified cmdlet. This must be a fixed string for a given cmdlet.

  • statusDescription
    Type: System.String

    Describes the current status of the cmdlet execution.

  • percentCompleted
    Type: System.Int32

    Indicates the state of completion of the cmdlet expressed as a percent.

See Also

Reference

SPCmdlet Class

SPCmdlet Members

WriteProgress Overload

Microsoft.SharePoint.PowerShell Namespace

Cmdlet.WriteProgress