Add-Member

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

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

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

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

Mit dem Cmdlet Add-Member können Sie einer Instanz eines PowerShell-Objekts Member (Eigenschaften und Methoden) hinzufügen. Sie können z. B. einen NoteProperty-Member hinzufügen, der eine Beschreibung des Objekts enthält, oder einen ScriptMethod-Member , der ein Skript zum Ändern des Objekts ausführt.

Um Add-Memberzu verwenden, übergeben Sie das Objekt an Add-Member, oder verwenden Sie den parameter InputObject, um das Objekt anzugeben.

Der parameter MemberType gibt den Typ des Hinzuzufügenden Elements an. Der parameter Name weist dem neuen Element einen Namen zu, und der parameter Value legt den Wert des Elements fest.

Die Eigenschaften und Methoden, die Sie hinzufügen, werden nur der bestimmten Instanz des angegebenen Objekts hinzugefügt. Add-Member Ändert den Objekttyp nicht. Verwenden Sie das Cmdlet Add-Type, um einen neuen Objekttyp zu erstellen.

Sie können auch das Cmdlet Export-Clixml verwenden, um die Instanz des Objekts, einschließlich der zusätzlichen Member, in einer Datei zu speichern. Anschließend können Sie das Import-Clixml Cmdlet verwenden, um die Instanz des Objekts aus den Informationen neu zu erstellen, die in der exportierten Datei gespeichert sind.

Ab Windows PowerShell 3.0 verfügt Add-Member über neue Features, die das Hinzufügen von Notizeigenschaften zu Objekten erleichtern. Sie können die parameter NotePropertyName und NotePropertyValue verwenden, um eine Notizeigenschaft zu definieren oder den NotePropertyMembers Parameter zu verwenden, der eine Hashtabelle mit Namen und Werten von Notizeigenschaften verwendet.

Ab Windows PowerShell 3.0 ist der PassThru Parameter, der ein Ausgabeobjekt generiert, weniger häufig erforderlich. Add-Member fügt jetzt die neuen Member direkt zum Eingabeobjekt weiterer Typen hinzu. Weitere Informationen finden Sie in der Beschreibung des PassThru- Parameters.

Im folgenden Beispiel wird dem FileInfo--Objekt, das die Datei darstellt, eine Test.txt Notizeigenschaft mit dem Wert "Done" hinzugefügt.

Der erste Befehl verwendet das cmdlet Get-ChildItem, um ein FileInfo- Objekt abzurufen, das die Test.txt Datei darstellt. Sie speichert sie in der variablen $a.

Mit dem zweiten Befehl wird dem Objekt in $adie Notizeigenschaft hinzugefügt.

Der dritte Befehl verwendet die Punktnotation, um den Wert der eigenschaft Status des Objekts in $aabzurufen. Wie die Ausgabe zeigt, lautet der Wert "Fertig".

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

Done

Im folgenden Beispiel wird dem Objekt, das die Datei darstellt, eine Test.txt Aliaseigenschaft hinzugefügt. Die neue Eigenschaft ist ein Alias für die eigenschaft Length.

Der erste Befehl verwendet das cmdlet Get-ChildItem zum Abrufen des Test.txtFileInfo-objekts.

Der zweite Befehl fügt die aliaseigenschaft Size hinzu. Der dritte Befehl verwendet die Punktnotation, um den Wert der neuen Size-Eigenschaft abzurufen.

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

2394

In diesem Beispiel wird der StringUse Notizeigenschaft zu einer Zeichenfolge hinzugefügt. Da Add-Member String-Eingabeobjekten keine Typen hinzugefügt werden können, können Sie den PassThru-Parameter angeben, um ein Ausgabeobjekt zu generieren. Der letzte Befehl im Beispiel zeigt die neue Eigenschaft an.

In diesem Beispiel wird der parameter NotePropertyMembers verwendet. Der Wert des NotePropertyMembers Parameter ist eine Hashtabelle. Der Schlüssel ist der Name der Notizeigenschaft, StringUse, und der Wert ist der Wert der Notizeigenschaft, Display.

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

Display

In diesem Beispiel wird einem FileInfo-Objekt die SizeInMB-Skriptmethode hinzugefügt, die die Dateigröße auf das nächste Megabyte genau berechnet. Der zweite Befehl erstellt eine ScriptBlock-, die die statische Methode Round aus dem typ [math] verwendet, um die Dateigröße auf die zweite Dezimalstelle zu runden.

Der parameter Value verwendet auch die $This automatische Variable, die das aktuelle Objekt darstellt. Die $This Variable ist nur in Skriptblöcken gültig, die neue Eigenschaften und Methoden definieren.

Der letzte Befehl verwendet Punktnotation, um die neue SizeInMB Skriptmethode für das Objekt in der $A Variablen aufzurufen.

$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

Diese Funktion kopiert alle Eigenschaften eines Objekts in ein anderes Objekt.

In der foreach Schleife wird das Get-Member Cmdlet verwendet, um die einzelnen Eigenschaften des From-Objekts abzurufen. Die Befehle innerhalb der foreach Schleife werden nacheinander für jede der Eigenschaften ausgeführt.

Der Add-Member Befehl fügt die Eigenschaft des From-Objekts dem To-Objekt als NoteProperty hinzu. Der Wert wird mit dem Parameter Wert kopiert. Er verwendet den Force-Parameter , um Member mit demselben Elementnamen hinzuzufügen.

function Copy-Property ($From, $To)
{
    $properties = Get-Member -InputObject $From -MemberType Property
    foreach ($p in $properties)
    {
        $To | Add-Member -MemberType NoteProperty -Name $p.Name -Value $From.$($p.Name) -Force
    }
}

In diesem Beispiel wird ein Objekt benutzerdefiniertes Objekt erstellt.

Das New-Object Cmdlet erstellt ein PSObject. Im Beispiel wird das PSObject in der $Asset Variablen gespeichert.

Der zweite Befehl verwendet die [ordered] Typzugriffstaste, um ein geordnetes Wörterbuch mit Namen und Werten zu erstellen. Der Befehl speichert das Ergebnis in der $D Variablen.

Der dritte Befehl verwendet den NotePropertyMembers-Parameter des Add-Member Cmdlets, um das Wörterbuch in der $D Variablen dem PSObject hinzuzufügen. Die TypeName-Eigenschaft weist dem PSObject den neuen Namen Asset zu.

Mit dem letzten Befehl wird das neue Asset-Objekt über die Pipeline an das Get-Member Cmdlet übergeben. Die Ausgabe zeigt, dass das Objekt den Typnamen Asset und die Notizeigenschaften hat, die wir im geordneten Wörterbuch definiert haben.

$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

   TypeName: Asset

Name        MemberType   Definition
----        ----------   ----------
Equals      Method       bool Equals(System.Object obj)
GetHashCode Method       int GetHashCode()
GetType     Method       type GetType()
ToString    Method       string ToString()
Name        NoteProperty System.String Name=Server30
PSVersion   NoteProperty System.String PSVersion=4.0
System      NoteProperty System.String System=Server Core

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Sie können jeden Objekttyp an dieses Cmdlet weiterleiten.

Wenn Sie den PassThru-Parameter verwenden, gibt dieses Cmdlet das neu erweiterte Objekt zurück. Andernfalls generiert dieses Cmdlet keine Ausgabe.

Sie können Member nur zu PSObject-Objekten hinzufügen. Um zu bestimmen, ob ein Objekt ein PSObject--Objekt ist, verwenden Sie den -is-Operator.

Um beispielsweise ein Objekt zu testen, das in der $obj Variablen gespeichert ist, geben Sie $obj -is [PSObject]ein.

Die Namen der MemberType, Name, Valueund SecondValue Parameter sind optional. Wenn Sie die Parameternamen weglassen, müssen die werte für nicht benannte Parameter in dieser Reihenfolge angezeigt werden: MemberType, Name, Valueund SecondValue.

Wenn Sie die Parameternamen einschließen, können die Parameter in beliebiger Reihenfolge angezeigt werden.

Sie können die $this automatische Variable in Skriptblöcken verwenden, die die Werte neuer Eigenschaften und Methoden definieren. Die $this Variable bezieht sich auf die Instanz des Objekts, der die Eigenschaften und Methoden hinzugefügt werden. Weitere Informationen zur $this Variablen finden Sie unter about_Automatic_Variables.