Add-Member

语法

Add-Member
   -InputObject <PSObject>
   -TypeName <String>
   [-PassThru]
   [<CommonParameters>]

Add-Member
   -InputObject <PSObject>
   [-TypeName <String>]
   [-Force]
   [-PassThru]
   [-NotePropertyMembers] <IDictionary>
   [<CommonParameters>]

Add-Member
   -InputObject <PSObject>
   [-TypeName <String>]
   [-Force]
   [-PassThru]
   [-NotePropertyName] <String>
   [-NotePropertyValue] <Object>
   [<CommonParameters>]

Add-Member
   -InputObject <PSObject>
   [-MemberType] <PSMemberTypes>
   [-Name] <String>
   [[-Value] <Object>]
   [[-SecondValue] <Object>]
   [-TypeName <String>]
   [-Force]
   [-PassThru]
   [<CommonParameters>]

说明

Add-Member cmdlet 允许将成员（属性和方法）添加到 PowerShell 对象的实例。 例如，可以添加一个 NoteProperty 成员，该成员包含对象的说明或运行脚本以更改对象的 ScriptMethod 成员。

若要使用 Add-Member，请通过管道将对象传递给 Add-Member，或使用 InputObject 参数指定对象。

MemberType 参数指示要添加的成员的类型。 Name 参数将名称分配给新成员，Value 参数设置成员的值。

添加的属性和方法仅添加到指定的对象的特定实例。 Add-Member 不会更改对象类型。 若要创建新的对象类型，请使用 Add-Type cmdlet。

还可以使用 Export-Clixml cmdlet 将对象实例（包括附加成员）保存在文件中。 然后，可以使用 Import-Clixml cmdlet 从导出的文件中存储的信息重新创建对象的实例。

从 Windows PowerShell 3.0 开始，Add-Member 具有新功能，以便更轻松地向对象添加笔记属性。 可以使用 NotePropertyName 和 NotePropertyValue 参数来定义注释属性或使用 NotePropertyMembers 参数，该参数采用注释属性名称和值的哈希表。

此外，从 Windows PowerShell 3.0 开始，PassThru 参数（生成输出对象的）频率较低。 Add-Member 现在直接将新成员添加到更多类型的输入对象。 有关详细信息，请参阅 PassThru 参数说明。

示例

示例 1：向 PSObject 添加备注属性

以下示例向表示 Test.txt 文件的 FileInfo 对象添加值为“Done”的 Status note 属性。

第一个命令使用 Get-ChildItem cmdlet 获取表示 Test.txt 文件的 FileInfo 对象。 它将保存在 $a 变量中。

第二个命令将 note 属性添加到 $a中的对象。

第三个命令使用点表示法获取 $a中对象的 Status 属性的值。 如输出所示，该值 Done。

$A = Get-ChildItem c:\ps-test\test.txt
$A | Add-Member -NotePropertyName Status -NotePropertyValue Done
$A.Status

Done

示例 2：向 PSObject 添加别名属性

以下示例将 Size 别名属性添加到表示 Test.txt 文件的对象。 新属性是 Length 属性的别名。

第一个命令使用 Get-ChildItem cmdlet 获取 Test.txtFileInfo 对象。

第二个命令添加 Size 别名属性。 第三个命令使用点表示法获取新 Size 属性的值。

$A = Get-ChildItem C:\Temp\test.txt
$A | Add-Member -MemberType AliasProperty -Name Size -Value Length
$A.Size

2394

示例 3：向字符串添加 StringUse 注释属性

此示例将 StringUse note 属性添加到字符串中。 由于 无法将类型添加到字符串 输入对象 ，因此可以指定 PassThru 参数来生成输出对象。 示例中的最后一个命令显示新属性。

此示例使用 NotePropertyMembers 参数。 NotePropertyMembers 参数的值是哈希表。 键是 note 属性名称，StringUse，值为 note 属性值，Display。

$A = "A string"
$A = $A | Add-Member -NotePropertyMembers @{StringUse="Display"} -PassThru
$A.StringUse

Display

示例 4：向 FileInfo 对象添加脚本方法

此示例将 SizeInMB 脚本方法添加到 FileInfo 对象，该对象将文件大小计算为最近的 MegaByte。 第二个命令创建一个 ScriptBlock，该脚本块使用 Round 静态方法从 [math] 类型将文件大小舍入到第二个小数位。

Value 参数还使用表示当前对象的 $This 自动变量。 $This 变量仅在定义新属性和方法的脚本块中有效。

最后一个命令使用点表示法对 $A 变量中的对象调用新的 SizeInMB 脚本方法。

$A = Get-ChildItem C:\Temp\test.txt
$S = {[math]::Round(($this.Length / 1MB), 2)}
$A | Add-Member -MemberType ScriptMethod -Name "SizeInMB" -Value $S
$A.SizeInMB()

0.43

示例 5：创建自定义对象

此示例创建 资产 自定义对象。

New-Object cmdlet 创建保存在 $Asset 变量中的 PSObject。 [ordered] 类型加速器创建存储在 $d 变量中的有序字典。 将管道 $AssetAdd-Member 将字典中的键值对作为 NoteProperty 成员添加到对象。 TypeName 参数将类型 Asset 分配给 PSObject。 Get-Member cmdlet 显示对象的类型和属性。 但是，这些属性按字母顺序列出，而不是按它们添加的顺序列出。

$Asset = New-Object -TypeName PSObject
$d = [ordered]@{Name="Server30"; System="Server Core"; PSVersion="4.0"}
$Asset | Add-Member -NotePropertyMembers $d -TypeName Asset
$Asset | Get-Member -MemberType Properties

TypeName: Asset

Name        MemberType   Definition
----        ----------   ----------
Name        NoteProperty string Name=Server30
PSVersion   NoteProperty string PSVersion=4.0
System      NoteProperty string System=Server Core

$Asset.PSObject.Properties | Format-Table Name, MemberType, TypeNameOfValue, Value

Name        MemberType TypeNameOfValue Value
----        ---------- --------------- -----
Name      NoteProperty System.String   Server30
System    NoteProperty System.String   Server Core
PSVersion NoteProperty System.String   4.0

检查属性的原始列表会显示属性的顺序，这些属性已添加到对象中。 此示例中使用 Format-Table 来创建类似于 Get-Member的输出。

示例 6：向对象添加 AliasProperty

在此示例中，我们创建了一个自定义对象，其中包含两个 NoteProperty 成员。 NoteProperty 的类型反映属性中存储的值的类型。 在这种情况下，Age 属性是字符串。

PS> $obj = [pscustomobject]@{
      Name = 'Doris'
      Age = '20'
}
PS> $obj | Add-Member -MemberType AliasProperty -Name 'intAge' -Value age -SecondValue uint32
PS> $obj | Get-Member

   TypeName: System.Management.Automation.PSCustomObject

Name        MemberType    Definition
----        ----------    ----------
intAge      AliasProperty intAge = (System.UInt32)age
Equals      Method        bool Equals(System.Object obj)
GetHashCode Method        int GetHashCode()
GetType     Method        type GetType()
ToString    Method        string ToString()
Age         NoteProperty  string Age=20
Name        NoteProperty  string Name=Doris

PS> $obj

Name  Age intAge
----  --- ------
Doris 20      20

PS> $obj.Age + 1

201

PS> $obj.intAge + 1

21

intAge 属性是 Age 属性的 AliasProperty，但类型保证 uint32。

示例 7：向自定义对象添加 get 和 set 方法

此示例演示如何定义 获取 和 设置访问深度嵌套属性的 方法。

$user = [pscustomobject]@{
    Name      = 'User1'
    Age       = 29
    StartDate = [datetime]'2019-05-05'
    Position  = [pscustomobject]@{
        DepartmentName = 'IT'
        Role = 'Manager'
    }
}
$addMemberSplat = @{
    MemberType = 'ScriptProperty'
    Name = 'Title'
    Value = { $this.Position.Role }                  # getter
    SecondValue = { $this.Position.Role = $args[0] } # setter
}
$user | Add-Member @addMemberSplat
$user | Get-Member

TypeName: System.Management.Automation.PSCustomObject

Name        MemberType     Definition
----        ----------     ----------
Equals      Method         bool Equals(System.Object obj)
GetHashCode Method         int GetHashCode()
GetType     Method         type GetType()
ToString    Method         string ToString()
Age         NoteProperty   int Age=29
Name        NoteProperty   string Name=User1
Position    NoteProperty   System.Management.Automation.PSCustomObject Position=@{DepartmentName=IT; Role=Manager}
StartDate   NoteProperty   datetime StartDate=5/5/2019 12:00:00 AM
Title       ScriptProperty System.Object Title {get= $this.Position.Role ;set= $this.Position.Role = $args[0] ;}

$user.Title = 'Dev Manager'

Name      : User1
Age       : 29
StartDate : 5/5/2019 12:00:00 AM
Position  : @{DepartmentName=IT; Role=Dev Manager}
Title     : Dev Manager

请注意，Title 属性是具有 Get 和 Set 方法的 ScriptProperty。 将新值分配给 Title 属性时，将调用 Set 方法，并更改 Position 属性中 Role 属性的值。

参数

-Force

-InputObject

-MemberType

-Name

-NotePropertyMembers

-NotePropertyName

-NotePropertyValue

-PassThru

-SecondValue

-TypeName

-Value

输入

PSObject

可以通过管道将任何对象传递给此 cmdlet。

输出

None

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

Object

使用 PassThru 参数时，此 cmdlet 将返回新扩展的对象。

备注

只能将成员添加到 PSObject 类型对象。 若要确定对象是否为 PSObject 对象，请使用 -is 运算符。 例如，若要测试存储在 $obj 变量中的对象，请键入 $obj -is [psobject]。

PSObject 类型对象按成员添加到对象的顺序维护其成员列表。

MemberType、Name、Value和 SecondValue 参数的名称是可选的。 如果省略参数名称，则未命名的参数值必须按以下顺序显示：MemberType、Name、Value和 SecondValue。

如果包括参数名称，参数可以按任意顺序显示。

可以在定义新属性和方法值的脚本块中使用 $this 自动变量。 $this 变量是指要向其添加属性和方法的对象实例。 有关 $this 变量的详细信息，请参阅 about_Automatic_Variables。

相关链接

• Export-Clixml
• Get-Member
• Import-Clixml
• New-Object
• about_Automatic_Variables
• System.Type.GetMethod（）