Add-Member

Syntax

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>]

Description

Med cmdleten Add-Member kan du lägga till medlemmar (egenskaper och metoder) i en instans av ett PowerShell-objekt. Du kan till exempel lägga till en NoteProperty- medlem som innehåller en beskrivning av objektet eller en ScriptMethod medlem som kör ett skript för att ändra objektet.

Om du vill använda Add-Memberkan du skicka objektet till Add-Membereller använda parametern InputObject för att ange objektet.

Parametern MemberType anger vilken typ av medlem du vill lägga till. Parametern Name tilldelar ett namn till den nya medlemmen och parametern Value anger värdet för medlemmen.

De egenskaper och metoder som du lägger till läggs bara till i den specifika instansen av objektet som du anger. Add-Member ändrar inte objekttypen. Om du vill skapa en ny objekttyp använder du cmdleten Add-Type.

Du kan också använda cmdleten Export-Clixml för att spara instansen av objektet, inklusive ytterligare medlemmar, i en fil. Sedan kan du använda cmdleten Import-Clixml för att återskapa instansen av objektet från den information som lagras i den exporterade filen.

Från och med Windows PowerShell 3.0 har Add-Member nya funktioner som gör det enklare att lägga till anteckningsegenskaper i objekt. Du kan använda parametrarna NotePropertyName och NotePropertyValue för att definiera en anteckningsegenskap eller använda parametern NotePropertyMembers, som tar en hashtabell med anteckningsegenskapsnamn och värden.

Från och med Windows PowerShell 3.0 behövs dessutom parametern PassThru, som genererar ett utdataobjekt, mindre ofta. Add-Member lägger nu till de nya medlemmarna direkt i indataobjektet för fler typer. Mer information finns i parameterbeskrivningen PassThru.

Exempel

Exempel 1: Lägg till en anteckningsegenskap i en PSObject

I följande exempel läggs egenskapen Status med värdet "Klar" till FileInfo-objekt som representerar Test.txt-filen.

Det första kommandot använder cmdleten Get-ChildItem för att hämta ett FileInfo-objekt som representerar Test.txt-filen. Den sparar den i variabeln $a.

Det andra kommandot lägger till anteckningsegenskapen i objektet i $a.

Det tredje kommandot använder punktkommentering för att hämta värdet för egenskapen Status för objektet i $a. Som utdata visar är värdet Done.

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

Done

Exempel 2: Lägga till en aliasegenskap i en PSObject

I följande exempel läggs egenskapen Size alias till objektet som representerar Test.txt-filen. Den nya egenskapen är ett alias för egenskapen Length.

Det första kommandot använder cmdleten Get-ChildItem för att hämta objektet Test.txtFileInfo.

Det andra kommandot lägger till egenskapen Size alias. Det tredje kommandot använder punktkommentering för att hämta värdet för den nya egenskapen Size.

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

2394

Exempel 3: Lägg till en StringUse-anteckningsegenskap i en sträng

Det här exemplet lägger till egenskapen StringUse note i en sträng. Eftersom Add-Member inte kan lägga till typer i String-indataobjekt kan du ange parametern PassThru för att generera ett utdataobjekt. Det sista kommandot i exemplet visar den nya egenskapen.

I det här exemplet används parametern NotePropertyMembers. Värdet för parametern NotePropertyMembers är en hash-tabell. Nyckeln är namnet på anteckningsegenskapen, StringUseoch värdet är egenskapen note, Visa.

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

Display

Exempel 4: Lägga till en skriptmetod i ett FileInfo-objekt

Det här exemplet lägger till skriptmetoden SizeInMB till ett FileInfo--objekt som beräknar filstorleken till närmaste MegaByte. Det andra kommandot skapar en ScriptBlock- som använder den statiska metoden Round från den [math] typen för att avrunda filstorleken till den andra decimalen.

Parametern Value använder också den $This automatiska variabeln som representerar det aktuella objektet. Variabeln $This är endast giltig i skriptblock som definierar nya egenskaper och metoder.

Det sista kommandot använder punktkommentering för att anropa den nya SizeInMB- skriptmetoden på objektet i $A variabeln.

$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

Exempel 5: Skapa ett anpassat objekt

I det här exemplet skapas ett tillgång anpassat objekt.

Cmdleten New-Object skapar en PSObject- som sparas i variabeln $Asset. Acceleratorn [ordered] typ skapar en ordnad ordlista som lagras i variabeln $d. Genom att skicka $Asset till Add-Member läggs nyckel/värde-paren i ordlistan till objektet som NoteProperty medlemmar. TypeName-parametern tilldelar typen Asset till PSObject-. Cmdleten Get-Member visar objektets typ och egenskaper. Egenskaperna visas dock i alfabetisk ordning, inte i den ordning som de lades till.

$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

När du granskar raw-listan med egenskaper visas egenskaperna i den ordning som de lades till i objektet. Format-Table används i det här exemplet för att skapa utdata som liknar Get-Member.

Exempel 6: Lägga till ett AliasProperty i ett objekt

I det här exemplet skapar vi ett anpassat objekt som innehåller två NoteProperty- medlemmar. Typen för en NoteProperty återspeglar typen av värdet som lagras i egenskapen. I det här fallet är egenskapen Age en sträng.

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

Egenskapen intAge är en AliasProperty- för egenskapen Age, men typen är garanterad uint32.

Exempel 7: Lägga till get- och set-metoder i ett anpassat objekt

De här exemplen visar hur du definierar Get and Set methods that access a deep nested property (Hämta och Ange metoder som har åtkomst till en djupt kapslad egenskap).

$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

Observera att egenskapen Title är en ScriptProperty- som har en metoden Get och Set. När vi tilldelar ett nytt värde till egenskapen Title anropas metoden Set och ändrar värdet för egenskapen Role i egenskapen Position.

Parametrar

-Force

-InputObject

-MemberType

-Name

-NotePropertyMembers

-NotePropertyName

-NotePropertyValue

-PassThru

-SecondValue

-TypeName

-Value

Indata

PSObject

Du kan skicka valfritt objekt till den här cmdleten.

Utdata

None

Som standard returnerar den här cmdleten inga utdata.

Object

När du använder parametern PassThru returnerar den här cmdleten det nyligen utökade objektet.

Kommentarer

Du kan bara lägga till medlemmar i PSObject typobjekt. Om du vill ta reda på om ett objekt är ett PSObject--objekt använder du operatorn -is. Om du till exempel vill testa ett objekt som lagras i variabeln $obj skriver du $obj -is [psobject].

PSObject objekt av typen underhåller deras lista över medlemmar i den ordning som medlemmarna har lagts till i objektet.

Namnen på parametrarna MemberType, Name, Valueoch SecondValue är valfria. Om du utelämnar parameternamnen måste de namnlösa parametervärdena visas i följande ordning: MemberType, Name, Valueoch SecondValue.

Om du inkluderar parameternamnen kan parametrarna visas i valfri ordning.

Du kan använda den $this automatiska variabeln i skriptblock som definierar värdena för nya egenskaper och metoder. Variabeln $this refererar till instansen av det objekt som egenskaperna och metoderna läggs till i. Mer information om variabeln $this finns i about_Automatic_Variables.

Relaterade länkar

• Export-Clixml
• Get-Member
• Import-Clixml
• New-Object
• about_Automatic_Variables
• System.Type.GetMethod()