Start-Transcript
在文本文件中创建全部或部分 Windows PowerShell 会话的记录。
语法
Start-Transcript [[-Path] <string>] [-Append] [-Force] [-NoClobber] [-Confirm] [-WhatIf] [<CommonParameters>]
说明
Start-Transcript cmdlet 在文本文件中创建全部或部分 Windows PowerShell 会话的记录。该脚本包括用户键入的所有命令以及控制台上显示的所有输出。
参数
-Append
将新脚本添加到现有文件的末尾。使用 Path 参数来指定文件。
是否为必需? |
false |
位置? |
named |
默认值 |
|
是否接受管道输入? |
false |
是否接受通配符? |
false |
-Force
允许该 cmdlet 将脚本追加到现有只读文件。用于只读文件时,该 cmdlet 会将文件权限更改为读写权限。即使使用 Force 参数,该 cmdlet 也无法覆盖安全限制。
是否为必需? |
false |
位置? |
named |
默认值 |
|
是否接受管道输入? |
false |
是否接受通配符? |
false |
-NoClobber
将不会覆盖现有文件(替换其内容)。默认情况下,如果指定的路径中存在脚本文件,则 Start-Transcript 将覆盖该文件,而不会发出警告。
是否为必需? |
false |
位置? |
named |
默认值 |
|
是否接受管道输入? |
false |
是否接受通配符? |
false |
-Path <string>
指定脚本文件的位置。输入 .txt 文件的路径。不允许使用通配符。
如果未指定路径,则 Start-Transcript 将使用 $Transcript 全局变量值中的路径。如果尚未创建此变量,则 Start-Transcript 会在 $Home\My Documents 目录中将脚本存储为 \PowerShell_transcript.<时间戳>.txt 文件。
如果路径中有任何目录不存在,则该命令将会失败。
是否为必需? |
false |
位置? |
1 |
默认值 |
|
是否接受管道输入? |
false |
是否接受通配符? |
false |
-Confirm
在执行命令之前提示您进行确认。
是否为必需? |
false |
位置? |
named |
默认值 |
|
是否接受管道输入? |
false |
是否接受通配符? |
false |
-WhatIf
描述如果执行该命令会发生什么情况(无需实际执行该命令)。
是否为必需? |
false |
位置? |
named |
默认值 |
|
是否接受管道输入? |
false |
是否接受通配符? |
false |
<CommonParameters>
此 cmdlet 支持通用参数:-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。有关详细信息,请参阅 about_Commonparameters.
输入和输出
输入类型是指可通过管道传递给 cmdlet 的对象的类型。返回类型是指 Cmdlet 所返回对象的类型。
输入 |
无 不能通过管道将对象传递给此 cmdlet。 |
输出 |
System.String Start-Transcript 返回一个包含确认消息和输出文件路径的字符串。 |
说明
若要停止脚本,请使用 Stop-Transcript cmdlet。
若要记录整个会话,请将 Start-Transcript 命令添加到您的配置文件中。有关详细信息,请参阅 about_Profiles。
示例 1
C:\PS>start-transcript
说明
-----------
此命令启动默认文件位置中的脚本。
示例 2
C:\PS>start-transcript -path c:\transcripts\transcript0.txt -noclobber
说明
-----------
此命令启动 C:\transcripts 下 Transcript0.txt 文件中的脚本。NoClobber 参数可防止覆盖任何现有文件。如果 Transcript0.txt 文件已存在,则该命令将会失败。