在 PowerShell 中终止脚本

Question

我一直在寻找一种方法来在函数中发生不可恢复的错误时终止 PowerShell (PS1) 脚本。例如：

function foo() {
    # Do stuff that causes an error
    $host.Exit()
}

当然没有$host.Exit() 这样的东西。有$host.SetShouldExit()，但这实际上关闭了控制台窗口，这不是我想要的。我需要的是相当于 Python 的 sys.exit() 的东西，它只会停止当前脚本的执行，而无需进一步告别。

编辑：是的，只是exit。呵呵。

Answer 1

我意识到这是一篇旧帖子，但我发现自己经常回到这个帖子，因为它是搜索这个主题时最热门的搜索结果之一。但是，由于信息相互矛盾，我总是比我来时更加困惑。最终，我总是必须执行自己的测试才能弄清楚。所以这次我将发布我的发现。

TL;DR 大多数人都希望使用Exit 来终止正在运行的脚本。但是，如果您的脚本只是声明稍后在 shell 中使用的函数，那么您将需要在所述函数的定义中使用 Return。

退出 vs 返回 vs 中断

• 退出：这将“退出”当前运行的上下文。如果您从脚本调用此命令，它将退出脚本。如果您从 shell 调用此命令，它将退出 shell。

  如果一个函数调用 Exit 命令，它将退出它正在运行的任何上下文。因此，如果该函数仅在正在运行的脚本中调用，它将退出该脚本。但是，如果您的脚本仅声明该函数以便可以从当前 shell 使用它并且您从 shell 运行该函数，它将退出 shell，因为 shell 是包含 Exit 命令的函数所在的上下文正在运行。

  注意： 默认情况下，如果您在 PowerShell 中右键单击脚本运行它，一旦脚本运行完成，PowerShell 将自动关闭。这与Exit 命令或脚本中的任何其他内容无关。对于使用这种运行脚本的特定方法运行的脚本来说，这只是默认的 PowerShell 行为。批处理文件和命令行窗口也是如此。

• 返回：这将返回到上一个调用点。如果您从脚本（在任何函数之外）调用此命令，它将返回到 shell。如果您从 shell 调用此命令，它将返回到 shell（这是从 shell 运行的单个命令的前一个调用点）。如果您从函数调用此命令，它将返回到调用函数的位置。

  在返回的调用点之后执行任何命令将从该点继续。如果从 shell 调用脚本并且它在任何函数之外包含 Return 命令，那么当它返回到 shell 时，没有更多命令可以运行，因此以这种方式使用的 Return 与 Exit 基本相同.

• Break：这将打破循环并切换情况。如果您在不在循环或 switch case 中调用此命令，它将跳出脚本。如果你在一个嵌套在循环内的循环内调用Break，它只会跳出它被调用的循环。

  Break 还有一个有趣的功能，您可以在循环前加上标签，然后即使在该标签循环内的多个嵌套组中调用 Break 命令，您也可以跳出该标签循环。

  While ($true) {
      # Code here will run
  
      :myLabel While ($true) {
          # Code here will run
  
          While ($true) {
              # Code here will run
  
              While ($true) {
                  # Code here will run
                  Break myLabel
                  # Code here will not run
              }
  
              # Code here will not run
          }
  
          # Code here will not run
      }
  
      # Code here will run
  }
  

Answer 2

你应该使用the exit keyword。

Answer 3

Exit 也将退出 PowerShell。如果您想“突破”当前函数或脚本 - 使用 Break :)

If ($Breakout -eq $true)
{
     Write-Host "Break Out!"
     Break
}
ElseIf ($Breakout -eq $false)
{
     Write-Host "No Breakout for you!"
}
Else
{
    Write-Host "Breakout wasn't defined..."
}

Answer 4

Write-Error 用于非终止错误，throw 用于终止错误

Write-Error cmdlet 声明了一个非终止错误。默认， 错误在错误流中发送到主机程序以进行处理 与输出一起显示。

非终止错误将错误写入错误流，但 它们不会停止命令处理。如果一个非终止错误是 在输入项集合中的一项上声明，命令 继续处理集合中的其他项目。

声明一个 终止错误，请使用 Throw 关键字。有关详细信息，请参阅 about_Throw (http://go.microsoft.com/fwlink/?LinkID=145153)。

Answer 5

终止此进程并为底层操作系统提供指定的退出代码。

https://msdn.microsoft.com/en-us/library/system.environment.exit%28v=vs.110%29.aspx

[Environment]::Exit(1)

这将允许您使用特定的退出代码退出，该代码可以从调用者处获取。

Answer 6

抛出异常会很好，特别是如果您想澄清错误原因：

throw "Error Message"

这将产生一个终止错误。

Answer 7

我认为您正在寻找 Return 而不是 Break。 Break 通常用于循环，并且仅从最里面的代码块中断。使用 Return 退出函数或脚本。

Answer 8

我偶然发现Break <i>&lt;UnknownLabel&gt;</i>（例如简单的Break <b>Script</b>，标签Script 不存在的地方）似乎脱离了整个脚本（甚至从函数内部） ) 并保持主机存活。
这样，您可以创建一个函数，在不知道当前范围（并创建标签）的情况下从任何地方（例如递归循环）中断脚本：

Function Quit($Text) {
    Write-Host "Quiting because: " $Text
    Break Script
} 

Answer 9

使用“trap”可能会更好。 PowerShell 陷阱指定在发生终止或错误时运行的代码块。类型

Get-Help about_trap

了解有关陷阱语句的更多信息。

Answer 10

我用它来重新运行程序。我不知道它是否会有所帮助，但这是一个简单的 if 语句，只需要两个不同的条目。它在我的 powershell 中工作。

$rerun = Read-Host "Rerun report (y/n)?"

if($rerun -eq "y") { Show-MemoryReport }
if($rerun -eq "n") { Exit }

不知道这是否有帮助，但我相信这类似于在您运行程序后终止程序。但是，在这种情况下，每个定义的输入都需要列出和分类的输出。您也可以让 exit 调用一个新的提示行并以这种方式终止程序。

Answer 11

我想出了一个巧妙的小技巧来做到这一点，当我想要一个函数退出脚本而不抛出错误，但如果从那里使用该函数则不退出控制台。它涉及到$PSScriptRoot 自动变量，该变量仅在运行脚本时定义。

if($PSScriptRoot){exit}