Set-Item

参考

模块:: Microsoft.PowerShell.Management

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

语法

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：创建别名

此命令为记事本创建 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
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-Options

这是别名和函数提供程序提供的动态参数。有关详细信息，请参阅 about_Alias_Provider 和 about_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

这是 注册表 提供程序提供的动态参数。 注册表 提供程序，此参数仅在 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 不返回任何输出。