PSHostUserInterface.WriteProgress Method

When overridden in a derived class, writes a progress report to be displayed to the user.


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

'Usage
Dim instance As PSHostUserInterface
Dim sourceId As Long
Dim record As ProgressRecord

instance.WriteProgress(sourceId, record)

public abstract void WriteProgress (
	long sourceId,
	ProgressRecord record
)
public abstract void WriteProgress (
	long sourceId, 
	ProgressRecord record
)
public abstract function WriteProgress (
	sourceId : long, 
	record : ProgressRecord
)

Parameters

sourceId

A unique identifier of the source of the record. An Int64 is used because the 'this' pointer of the command where the record originated from is used, and that may be from a remote runspace on a 64-bit computer.

record

A ProgressRecord object that contains the progress record to be displayed.

Exception typeCondition
HostException

The host can throw this exception when it cannot complete an operation.

NotImplementedException

If this method is not implemented, the host should throw a "not implemented" exception when it receives this call.

RuntimeException

The host can throw this exception when an error occurs while a command is running.

This method is invoked by a cmdlet call to the WriteProgress method.


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

 

Target Platforms

Windows 98, Windows 2000, Windows 2000 Server, Windows CE, Windows Server 2008, Windows 98 Second Edition, Pocket PC, Smart Phone, Windows Server 2003, Windows XP Professional, Windows Vista, Windows Server 2003 R2, Windows XP, Windows 7, Windows 2008 R2, Windows Developer Preview, Windows Server Developer Preview

Send comments about this topic to Microsoft.
Show:
© 2014 Microsoft