如何在PowerShell中正确使用$PSCmdlet.WriteError生成错误？

我在研究PowerShell错误消息生成时，看到以下示例代码：

$Exception = [Exception]::new("error message")
$ErrorRecord = [System.Management.Automation.ErrorRecord]::new(
    $Exception,
    "errorID",
    [System.Management.Automation.ErrorCategory]::NotSpecified,
    $TargetObject # usually the object that triggered the error, if possible
)
$PSCmdlet.WriteError($ErrorRecord)

运行后报错：

InvalidOperation: You cannot call a method on a null-valued expression.

我知道可以用Write-Error生成非终止错误，但不想让错误消息回显生成错误的命令，想了解正确使用$PSCmdlet.WriteError的方法。

问题原因 #

$PSCmdlet变量仅在高级函数或脚本（即添加了[CmdletBinding()]属性，或参数带有[Parameter()]属性的函数）中会被PowerShell自动初始化。直接在控制台或普通脚本中调用时，$PSCmdlet为$null，因此会触发“无法对空值表达式调用方法”的错误。

解决方法 #

1. 在高级函数中使用$PSCmdlet.WriteError

这是最规范的用法，将代码放在带有[CmdletBinding()]的高级函数内，同时确保$TargetObject已定义（不需要的话可以传$null）。示例：

function Test-CustomError {
    [CmdletBinding()]
    param()

    # 可选：定义触发错误的目标对象
    $TargetObject = "TestItem"
    # 创建异常对象
    $Exception = [Exception]::new("自定义错误内容")
    # 构造错误记录
    $ErrorRecord = [System.Management.Automation.ErrorRecord]::new(
        $Exception,
        "CustomError-001",
        [System.Management.Automation.ErrorCategory]::InvalidOperation,
        $TargetObject
    )
    # 写入错误
    $PSCmdlet.WriteError($ErrorRecord)
}

# 调用函数触发错误
Test-CustomError

这样生成的错误不会像Write-Error那样显示触发命令，只会输出自定义的错误信息、错误ID等内容。

2. 非高级函数场景的替代方案

如果不想编写高级函数，又要避免Write-Error显示命令本身，可以手动构造ErrorRecord并写入错误流，同时可选添加到$Error自动变量中：

$TargetObject = "TestItem"
$Exception = [Exception]::new("自定义错误内容")
$ErrorRecord = [System.Management.Automation.ErrorRecord]::new(
    $Exception,
    "CustomError-001",
    [System.Management.Automation.ErrorCategory]::InvalidOperation,
    $TargetObject
)

# 写入错误输出
$host.ui.WriteErrorLine($ErrorRecord.ToString())
# 可选：将错误记录添加到$Error变量
$Error.Add($ErrorRecord)

这种方式的错误格式和$PSCmdlet.WriteError略有差异，但能满足不显示触发命令的需求。

内容的提问来源于stack exchange，提问作者Dennis