Add-Member

Referenz

Modul:: Microsoft.PowerShell.Utility

Fügt einer Instanz eines PowerShell-Objekts benutzerdefinierte Eigenschaften und Methoden hinzu.

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

Beschreibung

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

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 cmdlet Import-Clixml verwenden, um die Instanz des Objekts aus den Informationen, die in der exportierten Datei gespeichert sind, neu zu erstellen.

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.

Beispiele

Beispiel 1: Hinzufügen einer Notizeigenschaft zu einem PSObject

Im folgenden Beispiel wird dem FileInfo--Objekt, das die Test.txt Datei darstellt, eine Status-eigenschaft 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

Beispiel 2: Hinzufügen einer Aliaseigenschaft zu einem PSObject

Im folgenden Beispiel wird dem Objekt, das die Test.txt Datei darstellt, eine Size 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

Beispiel 3: Hinzufügen einer StringUse-Notizeigenschaft zu einer Zeichenfolge

In diesem Beispiel wird der StringUse Notizeigenschaft zu einer Zeichenfolge hinzugefügt. Da Add-MemberString Eingabeobjekte keine Typen hinzufügen 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

Beispiel 4: Hinzufügen einer Skriptmethode zu einem FileInfo-Objekt

In diesem Beispiel wird die SizeInMB Skriptmethode zu einem FileInfo--Objekt hinzugefügt, das die Dateigröße auf das nächste MegaByte 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

Beispiel 5: Kopieren aller Eigenschaften eines Objekts in eine andere

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

Die foreach Schleife verwendet das cmdlet Get-Member, um die eigenschaften des From-Objekts abzurufen. Die Befehle innerhalb der foreach Schleife werden in Reihe zu den einzelnen Eigenschaften ausgeführt.

Der befehl Add-Member fügt die Eigenschaft des From-Objekts dem To-Objekt als NoteProperty-hinzu. Der Wert wird mithilfe des Value-Parameters kopiert. Er verwendet den Parameter Force, um Member mit demselben Membernamen 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
    }
}

Beispiel 6: Erstellen eines benutzerdefinierten Objekts

In diesem Beispiel wird ein Objekt benutzerdefiniertes Objekt erstellt.

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

Der zweite Befehl verwendet die Zugriffstaste [ordered] Typ, um ein sortiertes 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 Cmdlets Add-Member, um das Wörterbuch in der variablen $D zum PSObject-hinzuzufügen. Die TypeName-Eigenschaft weist dem PSObject-einen neuen Namen Assetzu.

Mit dem letzten Befehl wird das neue objekt Asset an das Cmdlet Get-Member weitergeleitet. Die Ausgabe zeigt, dass das Objekt einen Typnamen Objekt- und die Notizeigenschaften aufweist, die wir im sortierten 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

Parameter

-Force

Gibt an, dass dieses Cmdlet ein neues Element hinzufügt, selbst wenn das Objekt über ein benutzerdefiniertes Element mit demselben Namen verfügt. Sie können den Parameter "Force" nicht verwenden, um ein Standardelement eines Typs zu ersetzen.

Typ:	SwitchParameter
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-InputObject

Gibt das Objekt an, dem das neue Element hinzugefügt wird. Geben Sie eine Variable ein, die die Objekte enthält, oder geben Sie einen Befehl oder Ausdruck ein, der die Objekte abruft.

Typ:	PSObject
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-MemberType

Gibt den Typ des hinzuzufügenden Elements an. Dieser Parameter ist erforderlich. Die zulässigen Werte für diesen Parameter sind:

NoteProperty
AliasProperty
ScriptProperty
CodeProperty
ScriptMethod
CodeMethod

Informationen zu diesen Werten finden Sie unter PSMemberTypes Enumeration im PowerShell SDK.

Nicht alle Objekte weisen jeden Elementtyp auf. Wenn Sie einen Membertyp angeben, über den das Objekt nicht verfügt, gibt PowerShell einen Fehler zurück.

Typ:	PSMemberTypes
Aliase:	Type
Zulässige Werte:	AliasProperty, CodeProperty, Property, NoteProperty, ScriptProperty, Properties, PropertySet, Method, CodeMethod, ScriptMethod, Methods, ParameterizedProperty, MemberSet, Event, Dynamic, All
Position:	0
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-Name

Gibt den Namen des Elements an, das dieses Cmdlet hinzufügt.

Typ:	String
Position:	1
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-NotePropertyMembers

Gibt eine Hashtabelle oder ein sortiertes Wörterbuch von Notizeigenschaftennamen und -werten an. Geben Sie eine Hashtabelle oder ein Wörterbuch ein, in der die Schlüssel Notizeigenschaftennamen sind und die Werte Notizeigenschaftswerte sind.

Weitere Informationen zu Hashtabellen und geordneten Wörterbüchern in PowerShell finden Sie unter about_Hash_Tables.

Dieser Parameter wurde in Windows PowerShell 3.0 eingeführt.

Typ:	IDictionary
Position:	0
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-NotePropertyName

Gibt den Namen der Notizeigenschaft an.

Verwenden Sie diesen Parameter mit dem parameter NotePropertyValue. Dieser Parameter ist optional.

Dieser Parameter wurde in Windows PowerShell 3.0 eingeführt.

Typ:	String
Position:	0
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-NotePropertyValue

Gibt den Wert der Notizeigenschaft an.

Verwenden Sie diesen Parameter mit dem parameter NotePropertyName. Dieser Parameter ist optional.

Dieser Parameter wurde in Windows PowerShell 3.0 eingeführt.

Typ:	Object
Position:	1
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-PassThru

Gibt ein Objekt zurück, das das Element darstellt, mit dem Sie arbeiten. Standardmäßig generiert dieses Cmdlet keine Ausgabe.

Für die meisten Objekte fügt Add-Member dem Eingabeobjekt die neuen Elemente hinzu. Wenn das Eingabeobjekt jedoch eine Zeichenfolge ist, kann Add-Member das Element dem Eingabeobjekt nicht hinzufügen. Verwenden Sie für diese Objekte den PassThru--Parameter, um ein Ausgabeobjekt zu erstellen.

In Windows PowerShell 2.0 Add-Member member nur dem PSObject Wrapper von Objekten und nicht dem Objekt hinzugefügt. Verwenden Sie den PassThru--Parameter, um ein Ausgabeobjekt für jedes Objekt zu erstellen, das über einen PSObject- Wrapper verfügt.

Typ:	SwitchParameter
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-SecondValue

Gibt optionale zusätzliche Informationen zu AliasProperty-, ScriptProperty-, CodeProperty-oder CodeMethod- Membern an.

Wenn sie beim Hinzufügen eines AliasProperty-verwendet wird, muss dieser Parameter ein Datentyp sein. Eine Konvertierung in den angegebenen Datentyp wird dem Wert des AliasProperty-hinzugefügt.

Wenn Sie beispielsweise eine AliasProperty- hinzufügen, die einen alternativen Namen für eine Zeichenfolgeneigenschaft bereitstellt, können Sie auch einen SecondValue Parameter von System.Int32 angeben, um anzugeben, dass der Wert dieser Zeichenfolgeneigenschaft bei Verwendung der entsprechenden AliasProperty-in eine ganze Zahl konvertiert werden soll.

Sie können den parameter SecondValue verwenden, um ein zusätzliches ScriptBlock- anzugeben, wenn sie ein ScriptProperty Member hinzufügen. Der erste ScriptBlock-, der im parameter Value angegeben ist, wird verwendet, um den Wert einer Variablen abzurufen. Der zweite ScriptBlock-, der im parameter SecondValue angegeben ist, wird verwendet, um den Wert einer Variablen festzulegen.

Typ:	Object
Position:	3
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-TypeName

Gibt einen Namen für den Typ an.

Wenn es sich bei dem Typ um eine Klasse im System Namespace oder einen Typ handelt, der über eine Typbeschleuniger verfügt, können Sie den kurzen Namen des Typs eingeben. Andernfalls ist der vollständige Typname erforderlich. Dieser Parameter ist nur wirksam, wenn das InputObject- ein PSObject-ist.

Dieser Parameter wurde in Windows PowerShell 3.0 eingeführt.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-Value

Gibt den Anfangswert des hinzugefügten Elements an. Wenn Sie ein AliasProperty, CodeProperty, ScriptProperty oder CodeMethod Member hinzufügen, können Sie optionale zusätzliche Informationen mithilfe des SecondValue--Parameters bereitstellen.

Typ:	Object
Position:	2
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

Eingaben

PSObject

Sie können jeden Objekttyp an dieses Cmdlet weiterleiten.

Ausgaben

None or System.Object

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

Hinweise

Sie können Mitglieder 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.

Freigeben über

Add-Member

Syntax

Beschreibung

Beispiele

Beispiel 1: Hinzufügen einer Notizeigenschaft zu einem PSObject

Beispiel 2: Hinzufügen einer Aliaseigenschaft zu einem PSObject

Beispiel 3: Hinzufügen einer StringUse-Notizeigenschaft zu einer Zeichenfolge

Beispiel 4: Hinzufügen einer Skriptmethode zu einem FileInfo-Objekt

Beispiel 5: Kopieren aller Eigenschaften eines Objekts in eine andere

Beispiel 6: Erstellen eines benutzerdefinierten Objekts

Parameter

-Force

-InputObject

-MemberType

-Name

-NotePropertyMembers

-NotePropertyName

-NotePropertyValue

-PassThru

-SecondValue

-TypeName

-Value

Eingaben

Ausgaben

Hinweise

Zusätzliche Ressourcen

Freigeben über

Add-Member

Syntax

Beschreibung

Beispiele

Beispiel 1: Hinzufügen einer Notizeigenschaft zu einem PSObject

Beispiel 2: Hinzufügen einer Aliaseigenschaft zu einem PSObject

Beispiel 3: Hinzufügen einer StringUse-Notizeigenschaft zu einer Zeichenfolge

Beispiel 4: Hinzufügen einer Skriptmethode zu einem FileInfo-Objekt

Beispiel 5: Kopieren aller Eigenschaften eines Objekts in eine andere

Beispiel 6: Erstellen eines benutzerdefinierten Objekts

Parameter

-Force

-InputObject

-MemberType

-Name

-NotePropertyMembers

-NotePropertyName

-NotePropertyValue

-PassThru

-SecondValue

-TypeName

-Value

Eingaben

Ausgaben

Hinweise

Ähnliche Themen

Zusätzliche Ressourcen