Set-Item

参考

模块:: Microsoft.PowerShell.Management

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

语法

Set-Item
   [-Path] <String[]>
   [[-Value] <Object>]
   [-Force]
   [-PassThru]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-Item
   -LiteralPath <String[]>
   [[-Value] <Object>]
   [-Force]
   [-PassThru]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

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

示例

示例 1：创建别名

此命令为记事本创建 np 的别名。

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

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

此命令将 UserRole 环境变量的值更改为 Administrator。

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

示例 3：修改提示函数

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

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

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

此命令为提示函数设置 AllScope 和 ReadOnly 选项。此命令使用选项Set-Item动态参数。 Options 参数仅在别名或函数提供程序中使用时，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\*）时，Include 参数才有效，其中通配符指定 C:\Windows 目录的内容。

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

-LiteralPath

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

有关详细信息，请参阅 about_Quoting_Rules。

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

-PassThru

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

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

-Path

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

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

-Value

指定项的新值。

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

-WhatIf

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

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

输入

Object

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

输出

None or an object representing the new or changed item.

如果指定 PassThru 参数，则此 cmdlet 将生成表示项的对象。否则，此 cmdlet 不会生成任何输出。

备注

PowerShell FileSystem 提供程序不支持 Set-Item。若要更改文件系统中项的值，请使用 Set-Content cmdlet。
在注册表驱动器中，HKLM: 和 HKCU:，Set-Item 更改注册表项（默认值）值中的数据。
- 若要创建和更改注册表项的名称，请使用 New-Item 和 Rename-Item cmdlet。
- 若要更改注册表值中的名称和数据，请使用 New-ItemProperty、Set-ItemProperty和 Rename-ItemProperty cmdlet。
Set-Item 旨在处理任何提供程序公开的数据。若要列出会话中可用的提供程序，请键入 Get-PsProvider。有关详细信息，请参阅 about_Providers。

通过