常见参数名称

本主题中描述的参数称为 通用参数。 它们通过 Windows PowerShell 运行时添加到 cmdlet 中，不能由 cmdlet 声明。

备注

还会将这些参数添加到提供程序 cmdlet 以及用特性修饰的函数 CmdletBinding 。

一般常见参数

以下参数将添加到所有 cmdlet 中，并可在每次运行 cmdlet 时访问。 这些参数是由 Commonparameters 类定义的。

确认 (别名： cf)

数据类型： SwitchParameter

此参数指定该 cmdlet 是否显示提示，询问用户是否确实要继续。

调试 (别名： db)

数据类型： SwitchParameter

此参数指定是否可以在命令行中显示的程序员级调试消息。 这些消息用于对 cmdlet 的操作进行故障排除，并由对 WriteDebug 方法的调用生成。 调试消息无需本地化。

ErrorAction (别名： ea)

数据类型：枚举

此参数指定发生错误时应执行的操作。 此参数的可能值是由 Actionpreference 枚举定义的。

ErrorVariable (alias： ev)

数据类型：字符串

此参数指定发生错误时要在其中放置对象的变量。 若要追加到此变量，请使用 +varname ，而不是清除和设置变量。

OutBuffer (别名： ob)

数据类型： Int32

此参数定义在将任何对象向下传递管道之前要存储在输出缓冲区中的对象数。 默认情况下，对象会立即沿管道向下传递。

OutVariable (alias： ov-es)

数据类型：字符串

此参数指定在其中放置由 cmdlet 生成的所有输出对象的变量。 若要追加到此变量，请使用 +varname ，而不是清除和设置变量。

PipelineVariable (alias： pv)

数据类型：字符串

此参数将当前管道元素的值存储为任何命名命令的变量，因为它流经管道。

详细 (别名： vb)

数据类型： SwitchParameter

此参数指定该 cmdlet 是否写入可以在命令行中显示的解释性消息。 这些消息旨在向用户提供其他帮助，并通过对 WriteVerbose 方法的调用来生成它们。

WarningAction (别名： wa)

数据类型：枚举

此参数指定在 cmdlet 写入警告消息时应执行的操作。 此参数的可能值是由 Actionpreference 枚举定义的。

WarningVariable (alias： wv)

数据类型：字符串

此参数指定可在其中保存警告消息的变量。 若要追加到此变量，请使用 +varname ，而不是清除和设置变量。

Risk-Mitigation 参数

将以下参数添加到 cmdlet，这些 cmdlet 在执行操作之前请求确认。 有关确认请求的详细信息，请参阅 请求确认。 这些参数是由 Shouldprocessparameters 类定义的。

WhatIf (别名： wi)

数据类型： SwitchParameter

此参数指定该 cmdlet 是否写入一条消息，该消息描述运行 cmdlet 的效果，而不实际执行任何操作。

事务参数

将以下参数添加到支持事务的 cmdlet。 这些参数是由 Transactionparameters 类定义的。 Powershell 3.0 中引入了事务支持，在 PowerShell 6.0 中已停止使用。

UseTransaction (alias： usetx)

数据类型： SwitchParameter

此参数指定该 cmdlet 是否将使用当前事务来执行其操作。

另请参阅

System.web. Commonparameters。

System.web. Shouldprocessparameters。

System.web. Transactionparameters。

编写 Windows PowerShell Cmdlet

Windows PowerShell SDK