The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

CmdletProvider.WriteProgress Method (ProgressRecord)


Updated: April 27, 2016

Applies To: Windows PowerShell

Writes a progress record to the host application.

Namespace:   System.Management.Automation.Provider
Assembly:  System.Management.Automation (in System.Management.Automation.dll)

public void WriteProgress(
	ProgressRecord progressRecord


Type: System.Management.Automation.ProgressRecord

A ProgressRecord object that describes the progress of the operation performed by the provider.

Exception Condition

The pipeline is stopped. The pipeline was terminated either before the call was made or while the call was in progress. In general, the Windows PowerShell provider should allow the caller to catch this exception.

This method is called to display the progress of a provider when it is performing an operation that takes a long time.

By default, progress information is displayed. To change this behavior, reconfigure the ProgressPreference shell variable.

For more information about providers, see Windows PowerShell Providers [ps].

Return to top

Community Additions