Set-Item

将项的值更改为命令中指定的值。

语法

Set-Item
   [-Path] <string[]>
   [[-Value] <Object>]
   [-Force]
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]
Set-Item
   [[-Value] <Object>]
   -LiteralPath <string[]>
   [-Force]
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]
Set-Item
   [-Path] <string[]>
   [[-Value] <Object>]
   [-Force]
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [-Options <ScopedItemOptions>]
   [<CommonParameters>]
Set-Item
   [[-Value] <Object>]
   -LiteralPath <string[]>
   [-Force]
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [-Options <ScopedItemOptions>]
   [<CommonParameters>]
Set-Item
   [-Path] <string[]>
   [[-Value] <Object>]
   [-Force]
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [-Type <RegistryValueKind>]
   [<CommonParameters>]
Set-Item
   [[-Value] <Object>]
   -LiteralPath <string[]>
   [-Force]
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [-Type <RegistryValueKind>]
   [<CommonParameters>]

说明

Set-Item cmdlet 将项的值(如变量或注册表项)更改为命令中指定的值。

示例

示例 1:创建别名

此命令为 Notepad 创建别名 np。

Set-Item -Path alias:np -Value "c:\windows\notepad.exe"

示例 2:更改环境变量的值

此命令将 UserRole 环境变量的值更改为管理员。

Set-Item -Path env:UserRole -Value "Administrator"

示例 3:修改提示函数

此命令更改提示函数,以便显示路径前的时间。

Set-Item -Path function:prompt -Value {'PS '+ (Get-Date -Format t) + " " + (Get-Location) + '> '}

示例 4:设置提示函数的选项

此命令设置 prompt 函数的 AllScope 选项和 ReadOnly 选项。 此命令使用 Set-ItemOptions 动态参数。 只有在将 Options 参数与 AliasFunction 提供程序一起使用时,该参数才在 Set-Item 中可用。

Set-Item -Path function:prompt -Options "AllScope,ReadOnly"

参数

-Confirm

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

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

-Credential

注意

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

类型:PSCredential
Position:Named
默认值:Current user
必需:False
接受管道输入:True
接受通配符: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 设置非此不能更改的项(如只读的别名或变量)。 该 cmdlet 不能更改常量别名或变量。 不同提供程序有不同的实现。 有关详细信息,请参阅 about_Providers。 即使使用 Force 参数,该 cmdlet 也无法覆盖安全限制。

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

-Include

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

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

-LiteralPath

指定一个或多个位置的路径。 LiteralPath 的值严格按照所键入的形式使用。 不会将任何字符解释为通配符。 如果路径包括转义符,请将其括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。

有关详细信息,请参阅 about_Quoting_Rules

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

-Options

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

指定别名的 Options 属性的值。

有效值为:

  • None:别名没有约束(默认值)
  • ReadOnly:可以在不使用 Force 参数的情况下删除别名,但不能更改别名
  • Constant:无法删除或更改别名
  • Private:别名仅在当前作用域中可用
  • AllScope:将别名复制到任何创建的新作用域
  • Unspecified:未指定选项
类型:ScopedItemOptions
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-PassThru

将表示项的对象传递到管道。 默认情况下,此 cmdlet 将不产生任何输出。

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

-Path

指定项的路径。 允许使用通配符。

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

-Type

这是 Registry 提供程序提供的动态参数。 Registry 提供程序和此参数仅在 Windows 上可用。

指定此 cmdlet 添加的属性类型。 此参数的可接受值为:

  • String:指定以 null 结尾的字符串。 用于 REG_SZ 值。
  • ExpandString:指定一个以 null 结尾的字符串,该字符串包含对环境变量的未扩展的引用,这些引用会在检索值时扩展。 用于 REG_EXPAND_SZ 值。
  • Binary:指定采用任意格式的二进制数据。 用于 REG_BINARY 值。
  • DWord:指定一个 32 位的二进制数字。 用于 REG_DWORD 值。
  • MultiString:指定一个包含以 null 结尾的字符串的数组,该数组以两个 null 字符结尾。 用于 REG_MULTI_SZ 值。
  • Qword:指定一个 64 位的二进制数字。 用于 REG_QWORD 值。
  • Unknown:指示不受支持的注册表数据类型,例如 REG_RESOURCE_LIST 值。
类型:RegistryValueKind
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-UseTransaction

在活动事务中使用该命令。 仅当正在执行事务时,此参数才有效。 有关详细信息,请参阅 about_Transactions

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

-Value

为项指定新值。

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

-WhatIf

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

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

输入

Object

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

输出

None

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

Object

使用 PassThru 参数时,此 cmdlet 将返回一个表示项的对象。

备注

Windows PowerShell 包含 Set-Item 的以下别名:

  • si

  • PowerShell FileSystem 提供程序不支持 Set-Item。 若要更改文件系统中项的值,请使用 Set-Content cmdlet。

  • 在注册表驱动器 HKLM:HKCU: 中,Set-Item 更改注册表项(默认值)值中的数据。

    • 若要创建和更改注册表项的名称,请使用 New-ItemRename-Item cmdlet。
    • 若要更改注册表值中的名称和数据,请使用 New-ItemPropertySet-ItemPropertyRename-ItemProperty cmdlet。
  • Set-Item 旨在处理任何提供程序公开的数据。 若要列出会话中可用的提供程序,请键入 Get-PsProvider。 有关详细信息,请参阅 about_Providers