Out-String 帮助信息

如下说明是翻译 : help Out-String 产生的帮助信息 .

译者 : Edengundam( 马涛 )

 

Out-String

 

大纲

将对象作为连续的字符串发送到宿主上 (Host).

 

语法

Out-String [-inputObject <psobject>] [-width <int>] [-stream] [<CommonParameters>]

 

详细描述

Out-String cmdlet 将 Windows PowerShell 管理的对象转换为字符串数组 . 默认情况下 , Out-String 将积累这些字符串 , 最后将其作为一个整体返回 , 但是你能够使用 stream 参数使 Out-String 一次返回一个字符串 . 当对象的操作不太方便时 , 此 cmdlet 使得你像使用传统 shell 一样搜索和操作字符串输出 .

 

参数

 

-inputObject <psobject>

指定要被转换成字符串的对象 . 输入一个包含对象的变量 , 或者一个能够产生对象的命令或表达式 .

 

强制参数 ?	false
参数位置 ?	named
默认值
允许从管道绑定输入 ?	true ( 根据值 )
允许通配符扩展 ?	false

 

-width <int>

指定每行输出字符的数量 . 多余的字符将被截断 , 而非换行继续显示 . 如果你忽略此参数 , 宽度将通过宿主的特征决定 . PowerShell.exe 宿主的默认宽度为 80 ( 字符 ).

 

强制参数 ?	false
参数位置 ?	named
默认值	80
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-stream <SwitchParameter>

为每个对象独立地发送字符串 . 默认情况下 , 每个对象的字符串被累积 , 最后作为一个字符串输送 .

 

强制参数 ?	false
参数位置 ?	named
默认值	False
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

< 公共参数 >

此命令支持公共参数 : -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. 更多信息 , 输入 , "get-help about_commonparameters".

 

输入类型

Any

 

返回类型

String

 

注意

 

更多信息 , 输入 "Get-Help Out-String -detailed". 需要技术信息 , 输入 "Get-Help Out-String -full".

 

如果需要为该命令提供多个参数 , 请使用逗号进行分隔 . 例如 , "<parameter-name> <value1>, <value2>".

 

Out cmdlets 不会对对象进行格式化 ; 他们只显示这些对象 , 然后将他们发送到指定的目标 . 如果你给 Out cmdlet 发送一个没有格式化的对象 , cmdlet 在显示它前 , 先将该对象发送给格式化 cmdlet.

 

Out cmdlets 没有任何名称或文件路径的参数 . 要给 Out cmdlets 发送数据 , 使用管道运算符 (|) 将 Windows PowerShell 命令的输出发送给 cmdlet. 你也可以将数据存储在变量中 , 使用 InputObject 参数来讲数据传递给 cmdlet. 帮助信息 , 请看例子 .

 

例 1

 

C:/PS>get-content C:/test1/testfile2.txt | out-string

 

此命令将 Testfile2.txt 文件中的内容作为一个字符串发送到控制台 . 它使用 Get-Content cmdlet 取得文件中的内容 . 管道运算符 (|) 江内容发送给 Out-String, 后者将该内容作为一个字符串发送到控制台 .

 

例 2

 

C:/PS>$c = get-culture | select-object *

 

out-string -inputobject $c -width 100

 

这些命令获得当前用户设置的区域设置 , 并将数据转化为字符串 . 第一个命令使用 Get-Culture cmdlet 取得区域设置 . 管道运算符 (|) 将结果发送给 Select-Object cmdlet, 后者从 Get-Culture 命令返回的区域设置对象上 , 选择所有的属性 (*). 接下来命令将输出存储到 $c 变量中 .

 

第二命令使用 Out-String 将 CultureInfo 对象转换为一系列的字符串 ; 每个字符串表示一个属性 . 它使用 InputObject 参数将 $c 变量传递给 Out-String. 参数 width 设置为每行 100 个字符 , 用来防止截断 .

 

例 3

 

C:/PS>get-alias | out-string -stream | select-string "Get-Command"

 

此命令显示包含短语 "Get-Command" 的别名 . 它使用 Get-Alias cmdlet 取得一组 AliasInfo 对象 ; 每个对象表示 shell 中一个别名 . 这个例子揭示了使用对象和字符串的区别 .

 

管道运算符 (|) 将 Get-Alias 的结果发送给 Out-String, 后者将对象转换为一系列的字符串 . 使用 -stream 参数独立地发送每个字符串 , 而不是将他们做一个单独的字符串 . 后一个管道运算符将字符串发送给 Select-String , 后者选择那些在任意位置 , 包含 "Get-Command" 的字符串 .

 

如果你忽略 -stream 参数 , 命令将会显示所有别名 , 这是因为 Select-String 在 Out-String 返回的唯一一个字符串中查找 "Get-Command", 格式器将以表的形式显示选择的字符串 .

 

相关链接

Out-File

Out-Null

Out-Host

Out-Printer

Out-Default