Add-Member

Add-Member コマンドレットを使用すると、PowerShell オブジェクトのインスタンスにメンバー (プロパティとメソッド) を追加できます。 たとえば、オブジェクトの説明を含む NoteProperty メンバーや、オブジェクトを変更するスクリプトを実行する ScriptMethod メンバーを追加できます。

Add-Memberを使用するには、オブジェクトをパイプ処理して Add-Memberするか、InputObject パラメーターを使用してオブジェクトを指定します。

MemberType パラメーターは、追加するメンバーの種類を示します。 Name パラメーターは新しいメンバーに名前を割り当て、Value パラメーターはメンバーの値を設定します。

追加するプロパティとメソッドは、指定したオブジェクトの特定のインスタンスにのみ追加されます。 Add-Member オブジェクトの種類は変更されません。 新しいオブジェクトの種類を作成するには、Add-Type コマンドレットを使用します。

Export-Clixml コマンドレットを使用して、追加のメンバーを含むオブジェクトのインスタンスをファイルに保存することもできます。 その後、 Import-Clixml コマンドレットを使用して、エクスポートされたファイルに格納されている情報からオブジェクトのインスタンスを再作成できます。

Windows PowerShell 3.0 以降、Add-Member には、オブジェクトにノート プロパティを簡単に追加できる新機能があります。 NotePropertyName および NotePropertyValue パラメーター 使用して、ノート プロパティを定義したり、メモ プロパティの名前と値のハッシュ テーブルを取得する NotePropertyMembers パラメーターを使用したりできます。

また、Windows PowerShell 3.0 以降では、出力オブジェクトを生成する PassThru パラメーターが必要になる頻度が低くなります。 Add-Member、新しいメンバーが、より多くの型の入力オブジェクトに直接追加されるようになりました。 詳細については、PassThru パラメーターの説明を参照してください。

次の使用例は、 ファイルを表す FileInfo オブジェクトに、値が "Done" の Test.txt note プロパティを追加します。

最初のコマンドでは、Get-ChildItem コマンドレットを使用して、 ファイルを表す Test.txt オブジェクトを取得します。 $a 変数に保存されます。

2 番目のコマンドは、note プロパティを $aのオブジェクトに追加します。

3 番目のコマンドでは、ドット表記を使用して、のオブジェクトの $a プロパティの値を取得します。 出力が示すように、値は "Done" です。

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

Done

次の例では、 ファイルを表すオブジェクトに Test.txt エイリアス プロパティを追加します。 新しいプロパティは、Length プロパティのエイリアスです。

最初のコマンドでは、Get-ChildItem コマンドレットを使用して、Test.txtFileInfo オブジェクトを取得します。

2 番目のコマンドは、Size エイリアス プロパティを追加します。 3 番目のコマンドでは、ドット表記を使用して、新しい Size プロパティの値を取得します。

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

2394

次の使用例は、StringUse note プロパティを文字列に追加します。 Add-Member は String 入力オブジェクトに型を追加できないため、PassThru パラメータを指定して出力オブジェクトを生成できます。 この例の最後のコマンドは、新しいプロパティを表示します。

この例では、NotePropertyMembers パラメーターを使用します。 NotePropertyMembers パラメーターの値はハッシュ テーブルです。 キーはノート プロパティ名 StringUseで、値はノート プロパティの値 表示です。

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

Display

この例では、FileInfo オブジェクトに SizeInMB スクリプト メソッドを追加し、ファイル サイズを最も近いメガバイトに計算します。 2 番目のコマンドでは、Round 静的メソッドを使用する ScriptBlock を [math] 型から 2 番目の小数点に丸めます。

Value パラメーターは、現在のオブジェクトを表す $This 自動変数も使用します。 $This 変数は、新しいプロパティとメソッドを定義するスクリプト ブロックでのみ有効です。

最後のコマンドでは、ドット表記を使用して、 変数内のオブジェクトに対して新しい $A スクリプト メソッドを呼び出します。

$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

この関数は、あるオブジェクトのすべてのプロパティを別のオブジェクトにコピーします。

foreach ループでは、Get-Member コマンドレットを使用して、From オブジェクトの各プロパティを取得します。 foreachループ内のコマンドは、各プロパティで直列に実行されます。

Add-Member コマンドは、From オブジェクトのプロパティを NoteProperty として To オブジェクトに追加します。 値は Value パラメータを使用してコピーされます。 Force パラメータを使用して、同じメンバー名を持つメンバーを追加します。

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

次の使用例は、Asset カスタム オブジェクトを作成します。

New-Object コマンドレットは PSObject を作成します。 この例では、 PSObject を $Asset 変数に保存します。

2 番目のコマンドは、 [ordered] 型アクセラレータを使用して、名前と値の順序付きディクショナリを作成します。 このコマンドは、結果を $D 変数に保存します。

3 番目のコマンドでは、 コマンドレットの Add-Member パラメーターを使用して、$D 変数のディクショナリを PSObject に追加します。 TypeName プロパティによって、PSObject に新しい名前 Asset が割り当てられます。

最後のコマンドは、新しい Asset オブジェクトを Get-Member コマンドレットにパイプします。 出力は、オブジェクトのタイプ名が Asset で、順序付きディクショナリで定義したノートプロパティを持っていることを示しています。

$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

PSObject

任意の種類のオブジェクトをこのコマンドレットにパイプできます。

None or System.Object

PassThru パラメーターを使用すると、このコマンドレットは新しく拡張されたオブジェクトを返します。 それ以外の場合、このコマンドレットは出力を生成しません。

PSObject オブジェクトにのみメンバーを追加できます。 オブジェクトが PSObject オブジェクト かどうかを判断するには、-is 演算子を使用します。

たとえば、$obj 変数に格納されているオブジェクトをテストするには、「$obj -is [PSObject]」と入力します。

MemberType、Name、Value、および SecondValue パラメーター の名前は省略可能です。 パラメーター名を省略する場合、名前のないパラメーター値は、MemberType、Name、Value、および SecondValue の順序で指定する必要があります。

パラメーター名を含める場合、パラメーターは任意の順序で表示できます。

$this 自動変数は、新しいプロパティとメソッドの値を定義するスクリプト ブロックで使用できます。 $this 変数は、プロパティとメソッドが追加されるオブジェクトのインスタンスを参照します。 $this 変数の詳細については、「about_Automatic_Variables」を参照してください。