Set-Content

写入新内容或替换文件中的现有内容。

语法

Set-Content
   [-Path] <string[]>
   [-Value] <Object[]>
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Force]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [-NoNewline]
   [-Encoding <FileSystemCmdletProviderEncoding>]
   [-Stream <string>]
   [<CommonParameters>]
Set-Content
   [-Value] <Object[]>
   -LiteralPath <string[]>
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Force]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [-NoNewline]
   [-Encoding <FileSystemCmdletProviderEncoding>]
   [-Stream <string>]
   [<CommonParameters>]
Set-Content
   [-Path] <string[]>
   [-Value] <Object[]>
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Force]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]
Set-Content
   [-Value] <Object[]>
   -LiteralPath <string[]>
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Force]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]

说明

Set-Content 是一个字符串处理 cmdlet,用于写入新内容或替换文件中的内容。 Set-Content 替换现有内容,不同于将内容追加到文件的 Add-Content cmdlet。 若要将内容发送到 Set-Content 可以使用命令行上的 Value 参数或通过管道发送内容。

如果需要为以下示例创建文件或目录,请参阅 New-Item

示例

示例 1:替换目录中多个文件的内容

此示例替换当前目录中多个文件的内容。

Get-ChildItem -Path .\Test*.txt

Test1.txt
Test2.txt
Test3.txt

Set-Content -Path .\Test*.txt -Value 'Hello, World'
Get-Content -Path .\Test*.txt

Hello, World
Hello, World
Hello, World

Get-ChildItem cmdlet 使用 Path 参数列出以当前目录中 Test* 开头的 .txt 文件。 Set-Content cmdlet 使用 Path 参数来指定 Test*.txt 文件。 Value 参数提供替换每个文件中现有内容的文本字符串 Hello, WorldGet-Content cmdlet 使用 Path 参数来指定 Test*.txt 文件并在 PowerShell 控制台中显示每个文件的内容。

示例 2:创建新文件和写入内容

此示例创建一个新文件,并将当前日期和时间写入文件。

Set-Content -Path .\DateTime.txt -Value (Get-Date)
Get-Content -Path .\DateTime.txt

1/30/2019 09:55:08

Set-Content 使用 PathValue 参数在当前目录中创建名为 DateTime.txt 的新文件。 Value 参数使用 Get-Date 获取当前日期和时间。 Set-ContentDateTime 对象作为字符串写入文件。 Get-Content cmdlet 使用 Path 参数在 PowerShell 控制台中显示 DateTime.txt 的内容。

示例 3:替换文件中的文本

此命令替换现有文件中单词的所有实例。

Get-Content -Path .\Notice.txt

Warning
Replace Warning with a new word.
The word Warning was replaced.

(Get-Content -Path .\Notice.txt) |
    ForEach-Object {$_ -Replace 'Warning', 'Caution'} |
        Set-Content -Path .\Notice.txt
Get-Content -Path .\Notice.txt

Caution
Replace Caution with a new word.
The word Caution was replaced.

Get-Content cmdlet 使用 Path 参数指定当前目录中的 Notice.txt 文件。 Get-Content 命令用括号包装,以便命令在管道发送之前完成。

Notice.txt 文件的内容将管道向下发送到 ForEach-Object cmdlet。 ForEach-Object 使用自动变量 $_,并将 警告 的每个匹配项替换为 警告。 对象将管道向下发送到 Set-Content cmdlet。 Set-Content 使用 Path 参数指定 Notice.txt 文件并将更新的内容写入文件。

最后一个 Get-Content cmdlet 在 PowerShell 控制台中显示更新的文件内容。

示例 4:将筛选器与 Set-Content 配合使用

可以指定 Set-Content cmdlet 的筛选器。 使用筛选器限定 Path 参数时,需要包含尾随星号(*),以指示路径的内容。

以下命令将 C:\Temp 目录中所有 *.txt 文件的内容设置为空

Set-Content -Path C:\Temp\* -Filter *.txt -Value "Empty"

参数

-Confirm

在运行 cmdlet 之前,提示你进行确认。

类型:SwitchParameter
别名:cf
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

-Credential

注意

任何随 PowerShell 一起安装的提供程序都不支持此参数。 若要模拟其他用户,或在运行此 cmdlet 时提升凭据,请使用 Invoke-Command

类型:PSCredential
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-Encoding

这是 FileSystem 提供程序提供的动态参数。 有关详细信息,请参阅 about_FileSystem_Provider

指定目标文件的编码类型。 默认值为 Default

编码是 FileSystem 提供程序添加到 Set-Content的动态参数。 此参数仅适用于文件系统驱动器。

此参数的可接受值如下所示:

  • Ascii 使用 ASCII(7 位)字符集。
  • BigEndianUnicode 使用具有 big-endian 字节顺序的 UTF-16。
  • BigEndianUTF32 将 UTF-32 与 big-endian 字节顺序一起使用。
  • Byte 将一组字符编码为字节序列。
  • Default 使用与系统的活动代码页(通常是 ANSI)对应的编码。
  • Oem 使用与系统的当前 OEM 代码页对应的编码。
  • StringUnicode相同。
  • Unicode 将 UTF-16 与 little-endian 字节顺序一起使用。
  • UnknownUnicode相同。
  • UTF7 使用 UTF-7。
  • UTF8 使用 UTF-8。
  • UTF32 将 UTF-32 与 little-endian 字节顺序一起使用。

编码是 FileSystem 提供程序添加到 Set-Content的动态参数。 此参数仅适用于文件系统驱动器。

类型:FileSystemCmdletProviderEncoding
接受的值:ASCII, BigEndianUnicode, BigEndianUTF32, Byte, Default, OEM, String, Unicode, Unknown, UTF7, UTF8, UTF32
Position:Named
默认值:Default
必需:False
接受管道输入:False
接受通配符:False

-Exclude

指定此 cmdlet 在作中排除的项或项作为字符串数组。 此参数的值限定 Path 参数。 输入路径元素或模式,例如 *.txt。 允许使用通配符。 仅当命令包含项(如 C:\Windows\*)的内容(其中通配符指定 C:\Windows 目录的内容)时,Exclude 参数才有效。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:True

-Filter

指定用于限定 Path 参数的筛选器。 FileSystem 提供程序是唯一支持使用筛选器的已安装 PowerShell 提供程序。 可以在 about_Wildcards中找到 FileSystem 筛选器语言的语法。 筛选器比其他参数更有效,因为提供程序在 cmdlet 获取对象时应用它们,而不是在检索对象后让 PowerShell 筛选对象。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:True

-Force

强制 cmdlet 设置文件的内容,即使文件是只读的。 实现因提供程序而异。 有关详细信息,请参阅 about_ProvidersForce 参数不会替代安全限制。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Include

指定此 cmdlet 包含在作中的项(作为字符串数组)。 此参数的值限定 Path 参数。 输入路径元素或模式,例如 "*.txt"。 允许使用通配符。 仅当命令包含项的内容(如 C:\Windows\*)时,Include 参数才有效,其中通配符指定 C:\Windows 目录的内容。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:True

-LiteralPath

指定一个或多个位置的路径。 LiteralPath 的值与类型化完全相同。 不会将任何字符解释为通配符。 如果路径包含转义字符,请将它括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。

有关详细信息,请参阅 about_Quoting_Rules

类型:String[]
别名:PSPath
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-NoNewline

这是 FileSystem 提供程序提供的动态参数。 有关详细信息,请参阅 about_FileSystem_Provider

输入对象的字符串表示形式串联成输出。 输出字符串之间不插入空格或换行符。 最后一个输出字符串之后不会添加换行符。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-PassThru

返回一个表示内容的对象。 默认情况下,此 cmdlet 不生成任何输出。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Path

指定接收内容的项的路径。 允许使用通配符。

类型:String[]
Position:0
默认值:None
必需:True
接受管道输入:True
接受通配符:True

-Stream

这是 FileSystem 提供程序提供的动态参数。 此参数仅在 Windows 上可用。 有关详细信息,请参阅 about_FileSystem_Provider

指定内容的替代数据流。 如果该流不存在,则此 cmdlet 会创建它。 不支持通配符。

StreamFileSystem 提供程序添加到 Set-Content的动态参数。 此参数仅适用于文件系统驱动器。

可以使用 Set-Content cmdlet 创建或更新任何备用数据流的内容,例如 Zone.Identifier。 但是,我们不建议这样做,以此消除阻止从 Internet 下载的文件的安全检查。 如果验证下载的文件是否安全,请使用 Unblock-File cmdlet。

此参数是在 PowerShell 3.0 中引入的。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-UseTransaction

在活动事务中包含该命令。 此参数仅在事务正在进行时有效。 有关详细信息,请参阅 about_Transactions

类型:SwitchParameter
别名:usetx
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

-Value

指定项的新内容。

类型:Object[]
Position:1
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

输入

Object

可以通过管道将包含项的新值的对象传递给此 cmdlet。

输出

None

默认情况下,此 cmdlet 不返回任何输出。

String

使用 PassThru 参数时,此 cmdlet 返回表示内容的字符串。

备注

Windows PowerShell 包含以下 Set-Content别名:

  • sc

  • Set-Content 专为字符串处理而设计。 如果将非字符串对象通过管道传递给 Set-Content,则会在编写对象之前将该对象转换为字符串。 若要将对象写入文件,请使用 Out-File

  • Set-Content cmdlet 旨在处理任何提供程序公开的数据。 若要列出会话中可用的提供程序,请键入 Get-PsProvider。 有关详细信息,请参阅 about_Providers