PowerShell Write-Progress 帮助信息

关键字： PowerShell Write-Progress 帮助信息

如下说明是翻译: help write-progress 产生的帮助信息.

译者: Edengundam(马涛)

Write-Progress  (1)

大纲

在Windows PowerShell命令窗口中显示一个进度条.

语法

Write-Progress [-activity] <string> [-status] <string> [[-id] <int>] [-percentComplete <int>] [-secondsRemaining <int>] [-currentOperation <string>] [-parentId <int>] [-completed] [-sourceId <int>] [<CommonParameters>]

详细描述

在Windows PowerShell命令窗口中显示一个进度条. 进度条是否被显示, 取决于变量$ProgressPreference. 查看该变量取值, 输入 $ProgressPreference. 该变量的合法取值为: SilentlyContinue, Continue, Stop 和 Inquire. 如果该变量设置为SilentlyContinue, 控制台不会显示进度条. 在会话中设置该变量, 输入 $ProgressPreference = "<value>". 通过为Write-Progress提供运行命令或脚本的运行状态数据, 可以在控制台窗口中显示一个用于指示进度的进度条. (译者补: 使用Write-Progress监控的对象被称为活动Activity, 因为本单词对应汉语稍有晦涩, 次翻译较为欠妥)

参数

-activity <string>

指定一个字符串, 描述被该进度条指示的活动. 该字符串显示为进度条的第一标题.

-status <string>

指定一个字符串, 描述被该进度条指示活动的当前状态. 该字符串显示为进度条的第二标题.

-id <int>

指定此进度记录的活动标识符.

-percentComplete <int>

指定该活动总的完成百分比. 使用-1表示该百分比未知或暂时不可用.

-secondsRemaining <int>

指定该活动的预计剩余时间. 如果该值无法确定或暂时不可用, 请指定-1作为参数.

-currentOperation <string>

描述当前执行的操作.

-parentId <int>

当前活动的父活动描述符. 如果当前活动没有父活动, 请指定-1作为参数.

-completed <SwitchParameter>

指示该进度条是否显示. 如果设置为false, 只显示进度信息.

-sourceId <int>

指定记录的源ID

[1] [2]