如何实现PowerShell Function输出收集及return code处理？

作为经常和PowerShell打交道的开发者，我来给你拆解几种常见场景下的实现方式，帮你精准控制输出内容和返回码：

场景1：函数同时输出指定内容+返回自定义状态码 #

这是最常用的需求——既要在控制台输出提示/结果文本，又要返回一个可用于后续判断的状态码。核心思路是用Write-Host输出控制台内容，用return传递状态码：

function Invoke-FileOperation {
    # 输出你想要的特定提示内容
    Write-Host "开始处理文件：C:\temp\data.txt"

    # 模拟操作结果（实际场景替换为你的业务逻辑）
    $isSuccess = (Test-Path "C:\temp\data.txt")

    if ($isSuccess) {
        Write-Host "文件处理完成：✅ 成功"
        return 0  # 成功状态码
    }
    else {
        Write-Host "文件处理失败：❌ 目标文件不存在"
        return 1  # 失败状态码
    }
}

# 调用函数并捕获状态码
$operationResult = Invoke-FileOperation

# 根据状态码执行后续逻辑
if ($operationResult -eq 0) {
    Write-Host "触发后续流程：同步到云存储"
}
else {
    Write-Host "触发后续流程：发送告警邮件"
}

这里要注意：Write-Host的内容只会打印到控制台，不会混入函数的返回值；而return的值会被完整捕获，用于后续判断。

场景2：模拟外部命令的退出码（适配$LASTEXITCODE） #

如果你需要让函数的状态码像外部命令一样被$LASTEXITCODE变量捕获（比如兼容旧脚本逻辑），可以手动修改全局的$LASTEXITCODE：

function Test-ExternalCompatible {
    Write-Host "执行系统级操作..."

    $operationFailed = $false
    if ($operationFailed) {
        Write-Error "操作失败：权限不足"
        $global:LASTEXITCODE = 2  # 自定义失败退出码
        return
    }

    Write-Host "操作成功完成"
    $global:LASTEXITCODE = 0
}

Test-ExternalCompatible
Write-Host "当前退出码：$LASTEXITCODE"

⚠️ 注意：$LASTEXITCODE是全局变量，修改后会影响后续命令的判断，所以用完最好按需重置。

场景3：输出结构化内容+状态码（更严谨的写法） #

如果你的"特定内容"是结构化数据（比如自定义对象），同时要返回状态码，推荐用引用参数传递状态码，避免返回值混乱：

function Get-UserInfo {
    param(
        [ref]$StatusCode  # 引用参数用于传递状态码
    )

    # 输出结构化内容（作为函数返回值）
    $userData = [PSCustomObject]@{
        Username = "john_doe"
        Email = "john@example.com"
        LastLogin = (Get-Date).AddDays(-3)
    }

    # 通过引用设置状态码
    $StatusCode.Value = 0
    return $userData
}

# 初始化状态码变量
$status = 0
# 调用函数并捕获结构化内容
$userInfo = Get-UserInfo -StatusCode ([ref]$status)

# 分别处理内容和状态码
Write-Host "用户信息：$($userInfo.Username) <$($userInfo.Email)>"
Write-Host "查询状态码：$status"

这种写法避免了函数返回值同时包含内容和状态码的数组问题，逻辑更清晰。

避坑提醒 #

• 别搞混Write-Host和Write-Output：Write-Output的内容会成为函数返回值的一部分，如果你只想打印到控制台，一定要用Write-Host。
• PowerShell函数会自动返回所有未被捕获的输出：比如你在函数里不小心写了$variable而没有赋值或捕获，这个变量的内容会被当作返回值的一部分，导致状态码捕获异常。
• return不是必须的：PowerShell函数会默认返回所有输出流的内容，但用return可以提前终止函数执行，同时明确返回值。

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