Get-Content 帮助信息

如下说明是翻译 PowerShell 中 : help Get-Content 产生的帮助信息 .

译者 : Edengundam( 马涛 )

 

Get-Content

 

大纲

取得指定位置上的项的内容 .

 

语法

Get-Content [-path] <string[]> [-totalCount <long>] [-readCount <long>] [-include <string[]>] [-exclude <string[]>] [-filter <string>] [-force] [-credential <PSCredential>] [-encoding {<Unknown> | <String> | <Unicode> | <Byte> | <BigEndianUnicode> | <UTF8> | <UTF7> | <Ascii>}] [<CommonParameters>]

 

Get-Content [-literalPath] <string[]> [-totalCount <long>] [-readCount <long>] [-include <string[]>] [-exclude <string[]>] [-filter <string>] [-force] [-credential <PSCredential>] [-encoding {<Unknown> | <String> | <Unicode> | <Byte> | <BigEndianUnicode> | <UTF8> | <UTF7> | <Ascii>}] [<CommonParameters>]

 

详细描述

Get-Content cmdlet 取得路径指定的位置上项的内容 , 例如文件中的文本信息 . 它一次读取一行内容 , 并将每行当作一个对象返回 .

 

参数

 

-path <string[]>

指定项的路径 . Get-Content 取得指定项的内容 . 允许使用通配符 . 参数名称 ("-Path" or "-FilePath") 为可选项 .

 

强制参数 ?	true
参数位置 ?	1
默认值	N/A - The path must be specified
允许从管道绑定输入 ?	true ( 根据属性名 )
允许通配符扩展 ?	true

 

-totalCount <long>

指定需要取得的总行数 . 默认值为 -1 ( 所有行 ).

 

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

 

-readCount <long>

指定每次通过管道发送的行数 . 默认值为 0, 一次发送所有的内容 .

 

此参数不会影响内容的显示 , 但是影响着显示内容的时间 . 随着 ReadCount 的增加 , 返回第一行的时间逐渐增加 , 但是操作过程的总时间减少了 . 当输入项很大时 , 会感受到明显的区别 .

 

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

 

-include <string[]>

取得指定项 . 此参数值用于限定 Path 参数 . 输入一个路径元素或模式 , 例如 "*.txt" ( 此参数允许通配符 ) . 允许使用通配符 .

 

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

 

-exclude <string[]>

忽略指定项 . 此参数值用于限定 Path 参数 . 输入一个路径元素或模式 , 例如 "*.txt" ( 此参数允许通配符 ) . 允许使用通配符 .

 

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

 

-filter <string>

指定特定 provider 格式或语言的过滤器 . 此参数值用于限定 Path 参数 . 过滤器的语法取决于 provider ( 是否支持通配符也依赖 provider) . 过滤器相比其他参数更加有效 , 主要因为 provider 取值时候使用过滤器 , 而不是等到 provider 将所有内容返回后 , 由 Windows PowerShell 过滤对象 .

 

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

 

-force <SwitchParameter>

在不破坏安全性的前提下 , 能够避免影响命令成功执行的限制条件 , 例如 : Force 参数能够覆盖具有只读属性的文件或创建路径中的必要成分 , 但是不会改变任何文件的权限 .

 

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

 

-credential <PSCredential>

使用其他凭证进行文件访问认证 . <Credential> 代表着用户名 ( 例如 : "User01" 或 "Domain01/User01") 或者 PSCredential 对象 ( 例如 : 通过 Get-Credential cmdlet 取得的对象 ). 如果此处使用用户名 , 命令执行时会提示输入该用户密码 . 尽管此参数出现 , 但是并非所有 Windows PowerShell 核心 cmdlets 或 providers 支持此功能 .

 

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

 

-encoding <FileSystemCmdletProviderEncoding>

指定用于显示内容的字符编码类型 . 此参数只能在 Windows PowerShell 文件系统提供程序中使用 .

 

下面列出此参数接受的值 :

 

·          Unknown

·          String

·          Unicode

·          Byte

·          BigEndian

·          Unicode

·          UTF8

·          UTF7

·          Ascii

 

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

 

-literalPath <string[]>

指定项的路径 . 与 Path 不同 , LiteralPath 的值被直接使用 , 不会对任何通配符进行解释 . 如果路径中包含了转义字符 , 需要将路径用单引号保护 . 单引号指示 Windows PowerShell 不对字符串中的转义字符进行处理 .

 

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

 

< 公共参数 >

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

 

注意

 

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

 

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

 

你可以使用 Get-Content 的 内建别名 "cat", "type" 和 "gc". 需要更多信息 , 查看 About_Alias.

 

例 1

 

C:/PS>get-content -Path C:/Chapters/chapter1.txt

 

此命令在控制台上显示文件 Chapter1.txt 的内容 . 此命令使用参数 Path 来指定项的名称 ( 路径 ). Get-Content 实际上将文件内容继续沿着管道线传递 , 由于没有任何后继管道成员 , 内容被格式化并显示在控制台上 .

 

例 2

 

C:/PS>get-content c:/Logs/Log060912.txt -totalcount 50 | set-content sample.txt

 

此命令取得文件 Log060912.txt 的前 50 行并将它们存储在文件 sample.txt 中 . 命令使用 Get-Content cmdlet 取得文件中的文本 . ( 参数 Path 的名称是可选项 , 在这个例子中被省略了 .) 参数 TotalCount 限制只取得前 50 行 . 管道运算符 (|) 将结果发送到 Set-Content , 后者将它们存储到文件 sample.txt 中 .

 

相关链接

Add-Content

Set-Content

Clear-Content

about_namespace