Share via

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

说明

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

示例

示例 1：Create别名

此命令为记事本创建 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 选项。 此命令使用 的 Options 动态参数 Set-Item。 仅当将 Options 参数与别名或函数提供程序一起使用时，才在 中Set-Item可用。

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

参数

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

注意

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

Type:PSCredential
Position:Named
Default value:Current user
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Exclude

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

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Filter

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Force

强制 cmdlet 设置无法更改的项，例如只读别名或变量。 该 cmdlet 不能更改常量别名或变量。 不同提供程序有不同的实现。 有关详细信息，请参阅 about_Providers。 即使使用 Force 参数，cmdlet 也无法替代安全限制。

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Include

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

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-LiteralPath

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

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

Type:String[]
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Options

这是 别名 和 函数 提供程序提供的动态参数。 有关详细信息，请参阅 about_Alias_Provider 和 about_Function_Provider。

指定别名的 Options 属性的值。

有效值为：

  • None：别名没有约束 (默认值)
  • ReadOnly：别名可以删除，但如果不使用 Force 参数，则不能更改
  • Constant：无法删除或更改别名
  • Private：别名仅在当前范围内可用
  • AllScope：别名将复制到创建的任何新范围
  • Unspecified：未指定选项
Type:ScopedItemOptions
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

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

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

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

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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 值。
Type:RegistryValueKind
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Value

为项指定新值。

Type:Object
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

输入

Object

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

输出

None

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

Object

使用 PassThru 参数时，此 cmdlet 返回表示项的对象。

备注

PowerShell 包含以下别名 Set-Item：

  • 所有平台：

    • si

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

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

    • 若要创建和更改注册表项的名称，请使用 New-Item 和 Rename-Item cmdlet。
    • 若要更改注册表值中的名称和数据，请使用 New-ItemProperty、 Set-ItemProperty和 Rename-ItemProperty cmdlet。

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