将输出发送到命令行。
语法
Out-Host [-InputObject <psobject>] [-Paging] [<CommonParameters>]
说明
Out-Host cmdlet 将输出发送到 Windows PowerShell 主机以进行显示。主机将在命令行显示输出。因为 Out-Host 是默认设置,所以除非要使用其参数来更改显示,否则不需要指定它。
参数
-InputObject <psobject>
指定写入控制台的对象。输入一个包含对象的变量,或键入可获取对象的命令或表达式。
是否为必需? |
false |
位置? |
named |
默认值 |
|
是否接受管道输入? |
true (ByValue) |
是否接受通配符? |
false |
-Paging
输出每次显示一页,在显示其余页之前会等待用户输入,这很像传统的“more”命令。默认情况下,所有输出均以单页显示。页大小由主机的特征确定。
是否为必需? |
false |
位置? |
named |
默认值 |
|
是否接受管道输入? |
false |
是否接受通配符? |
false |
<CommonParameters>
此 cmdlet 支持通用参数:-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。有关详细信息,请参阅 about_Commonparameters.
输入和输出
输入类型是指可通过管道传递给 cmdlet 的对象的类型。返回类型是指 Cmdlet 所返回对象的类型。
输入 |
System.Management.Automation.PSObject 可以通过管道将任何对象传递给 Out-Host。 |
输出 |
None Out-Host 不生成任何输出。但是,主机可能显示 Out-Host 向其发送的对象。 |
说明
还可以使用 Out-Host 的内置别名“oh”来对其进行引用。有关详细信息,请参阅 about_Aliases。
包含 Out 动词的 cmdlet(输出 cmdlet)不格式化对象;它们只呈现对象,并将对象发送到指定的显示目标。如果将未格式化的对象发送给输出 cmdlet,该 cmdlet 会为它生成显示信息,然后将它发送给格式化 cmdlet。
输出 cmdlet 没有用于提供名称和文件路径的参数。若要向某个输出 cmdlet 发送数据,请使用管道运算符 (|) 将 Windows PowerShell 命令的输出发送到该 cmdlet。还可以将数据存储在变量中,并使用 InputObject 参数将数据传递给 cmdlet。有关帮助信息,请参阅相关示例。
Out-Host 发送数据,但不发出任何输出对象。如果将 Out-Host 的输出通过管道传递给 Get-Member,则 Get-Member 将报告尚未指定对象。
示例 1
C:\PS>get-process | out-host -paging 说明 ----------- 此命令每次一页地显示系统中的进程。它使用 Get-Process 命令获取系统中的进程。管道运算符 (|) 将结果发送给 Out-Host,后者将它们显示在控制台上。Paging 参数使数据每次显示一页。 内置在 Windows PowerShell 中的 Help 函数使用相同的命令格式。该函数从 Get-Help 获取数据,然后使用 Out-Host 的 Paging 参数使数据每次显示一页,其命令格式如下:get-help $args[0] | out-host -paging。
示例 2
C:\PS>$a = get-history C:\PS>out-host -InputObject $a 说明 ----------- 这些命令在命令行显示会话历史记录。第一条命令使用 Get-History cmdlet 获取会话历史记录,然后将历史记录存储在 $a 变量中。第二条命令使用 Out-Host 显示 $a 变量的内容,并使用 InputObject 参数将变量指定为 Out-Host。
另请参阅