Add-Type
PowerShell セッションに Microsoft .NET クラスを追加します。
構文
Add-Type
[-TypeDefinition] <String>
[-Language <Language>]
[-ReferencedAssemblies <String[]>]
[-OutputAssembly <String>]
[-OutputType <OutputAssemblyType>]
[-PassThru]
[-IgnoreWarnings]
[-CompilerOptions <String[]>]
[<CommonParameters>]
Add-Type
[-Name] <String>
[-MemberDefinition] <String[]>
[-Namespace <String>]
[-UsingNamespace <String[]>]
[-Language <Language>]
[-ReferencedAssemblies <String[]>]
[-OutputAssembly <String>]
[-OutputType <OutputAssemblyType>]
[-PassThru]
[-IgnoreWarnings]
[-CompilerOptions <String[]>]
[<CommonParameters>]
Add-Type
[-Path] <String[]>
[-ReferencedAssemblies <String[]>]
[-OutputAssembly <String>]
[-OutputType <OutputAssemblyType>]
[-PassThru]
[-IgnoreWarnings]
[-CompilerOptions <String[]>]
[<CommonParameters>]
Add-Type
-LiteralPath <String[]>
[-ReferencedAssemblies <String[]>]
[-OutputAssembly <String>]
[-OutputType <OutputAssemblyType>]
[-PassThru]
[-IgnoreWarnings]
[-CompilerOptions <String[]>]
[<CommonParameters>]
Add-Type
-AssemblyName <String[]>
[-PassThru]
[<CommonParameters>]
説明
Add-Type
コマンドレットを使用すると、PowerShell セッションで Microsoft .NET Core クラスを定義できます。 その後、 コマンドレットを使用してオブジェクトを New-Object
インスタンス化し、.NET Core オブジェクトを使用するのと同じように オブジェクトを使用できます。 PowerShell プロファイルにコマンドを Add-Type
追加すると、クラスはすべての PowerShell セッションで使用できます。
既存のアセンブリまたはソース コード ファイルを指定して型を指定することも、インラインで、または変数に保存されたソース コードを指定することもできます。 メソッドのみを指定し、 Add-Type
クラスを定義して生成することもできます。 Windows では、この機能を使用して、PowerShell のアンマネージド関数に対してプラットフォーム呼び出し (P/Invoke) 呼び出しを行うことができます。 ソース コードを指定した場合は、 Add-Type
指定したソース コードをコンパイルし、新しい .NET Core 型を含むメモリ内アセンブリを生成します。
のパラメーター Add-Type
を使用して、代替言語とコンパイラを指定できます。C# は既定、コンパイラ オプション、アセンブリ依存関係、クラス名前空間、型の名前、および結果のアセンブリです。
PowerShell 7 以降では、 Add-Type
同じ名前の型が既に存在する場合、型はコンパイルされません。 また、 Add-Type
を含むフォルダーの ref
下にあるフォルダー内のアセンブリを pwsh.dll
検索します。
例
例 1: セッションに .NET 型を追加する
次の使用例は、変数に格納されているソース コードを指定して、 BasicTest クラスをセッションに追加します。 BasicTest クラスは、整数の追加、オブジェクトの作成、整数の乗算に使用されます。
$Source = @"
public class BasicTest
{
public static int Add(int a, int b)
{
return (a + b);
}
public int Multiply(int a, int b)
{
return (a * b);
}
}
"@
Add-Type -TypeDefinition $Source
[BasicTest]::Add(4, 3)
$BasicTestObject = New-Object BasicTest
$BasicTestObject.Multiply(5, 2)
変数には $Source
、 クラスのソース コードが格納されます。 型には という静的メソッドと、 というAdd
Multiply
非静的メソッドがあります。
コマンドレットは Add-Type
、 クラスをセッションに追加します。 インライン ソース コードを使用しているため、コマンドは TypeDefinition パラメーターを使用して変数内のコードを $Source
指定します。
BasicTest クラスの静的メソッドはAdd
、二重コロン文字 (::
) を使用してクラスの静的メンバーを指定します。 整数が追加され、合計が表示されます。
コマンドレットは New-Object
、 BasicTest クラスのインスタンスをインスタンス化します。 新しいオブジェクトが変数に $BasicTestObject
保存されます。
$BasicTestObject
は メソッドを使用します Multiply
。 整数が乗算され、積が表示されます。
例 2: 追加された型を調べる
この例では、 コマンドレットをGet-Member
使用して、 コマンドレットと New-Object
コマンドレットがAdd-Type
作成したオブジェクトを調べます。例 1.
[BasicTest] | Get-Member
TypeName: System.RuntimeType
Name MemberType Definition
---- ---------- ----------
AsType Method type AsType()
Clone Method System.Object Clone(), System.Object ICloneable.Clone()
Equals Method bool Equals(System.Object obj), bool Equals(type o)
FindInterfaces Method type[] FindInterfaces(System.Reflection.TypeFilter filter...
...
[BasicTest] | Get-Member -Static
TypeName: BasicTest
Name MemberType Definition
---- ---------- ----------
Add Method static int Add(int a, int b)
Equals Method static bool Equals(System.Object objA, System.Object objB)
new Method BasicTest new()
ReferenceEquals Method static bool ReferenceEquals(System.Object objA, System.Object objB)
$BasicTestObject | Get-Member
TypeName: BasicTest
Name MemberType Definition
---- ---------- ----------
Equals Method bool Equals(System.Object obj)
GetHashCode Method int GetHashCode()
GetType Method type GetType()
Multiply Method int Multiply(int a, int b)
ToString Method string ToString()
コマンドレットは Get-Member
、セッションに追加された BasicTest クラス Add-Type
の型とメンバーを取得します。 コマンドはGet-Member
、System.Object クラスから派生した System.RuntimeType オブジェクトであることを示します。
Static パラメーターはGet-Member
、BasicTest クラスの静的プロパティとメソッドを取得します。 出力は、 メソッドが含まれていることを Add
示しています。
コマンドレットは Get-Member
、 変数に格納されているオブジェクトのメンバーを $BasicTestObject
取得します。
$BasicTestObject
は、 コマンドレットと New-Object
BasicTest クラスを使用して作成されました。 出力では、変数の $BasicTestObject
値が BasicTest クラスのインスタンスであり、 という名前 Multiply
のメンバーが含まれていることが明らかになります。
例 3: アセンブリから型を追加する
次の使用例は、アセンブリから現在の NJsonSchema.dll
セッションにクラスを追加します。
Set-Location -Path $PSHOME
$AccType = Add-Type -AssemblyName *jsonschema* -PassThru
Set-Location
は Path パラメーターを使用して変数を指定します$PSHOME
。 変数は、DLL ファイルが配置されている PowerShell インストール ディレクトリを参照します。
変数には $AccType
、 コマンドレットを使用して作成されたオブジェクトが Add-Type
格納されます。 Add-Type
では、 AssemblyName パラメーターを使用してアセンブリの名前を指定します。 アスタリスク (*
) ワイルドカード文字を使用すると、名前やそのスペルが不明な場合でも、正しいアセンブリを取得できます。 PassThru パラメーターは、セッションに追加されるクラスを表すオブジェクトを生成します。
例 4: ネイティブ Windows API を呼び出す
この例では、PowerShell でネイティブ Windows API を呼び出す方法を示します。 Add-Type
では、プラットフォーム呼び出し (P/Invoke) メカニズムを使用して PowerShell から 関数 User32.dll
を呼び出します。 この例は、Windows オペレーティング システムを実行しているコンピューターでのみ機能します。
$Signature = @"
[DllImport("user32.dll")]public static extern bool ShowWindowAsync(IntPtr hWnd, int nCmdShow);
"@
$addTypeSplat = @{
MemberDefinition = $Signature
Name = "Win32ShowWindowAsync"
Namespace = 'Win32Functions'
PassThru = $true
}
$ShowWindowAsync = Add-Type @addTypeSplat
# Minimize the PowerShell console
$ShowWindowAsync::ShowWindowAsync((Get-Process -Id $pid).MainWindowHandle, 2)
# Restore the PowerShell console
$ShowWindowAsync::ShowWindowAsync((Get-Process -Id $Pid).MainWindowHandle, 4)
変数には $Signature
、 関数の C# シグネチャが ShowWindowAsync
格納されます。 結果のメソッドが PowerShell セッションで確実に表示されるようにするために、public
キーワード (keyword)が標準署名に追加されました。 詳細については、「 ShowWindowAsync 関数」を参照してください。
変数には$ShowWindowAsync
、PassThru パラメーターによって作成されたオブジェクトがAdd-Type
格納されます。
コマンドレットは Add-Type
、関数を ShowWindowAsync
静的メソッドとして PowerShell セッションに追加します。 このコマンドでは 、MemberDefinition パラメーターを使用して、変数に保存されたメソッド定義を $Signature
指定します。 このコマンドは、Name および Namespace パラメーターを使用して、クラスの名前と名前空間を指定します。 PassThru パラメーターは、型を表すオブジェクトを生成します。
新しい ShowWindowAsync
静的メソッドは、PowerShell コンソールを最小化および復元するためにコマンドで使用されます。 メソッドは、ウィンドウ ハンドルと、ウィンドウの表示方法を指定する整数の 2 つのパラメーターを受け取ります。
PowerShell コンソールを最小限に抑えるために、 ShowWindowAsync
コマンドレットと自動変数を$PID
使用Get-Process
して、現在の PowerShell セッションをホストしているプロセスを取得します。 次に、現在のプロセスの MainWindowHandle プロパティと、値を表す の 2
値を SW_MINIMIZE
使用します。
ウィンドウを復元するには、 ShowWindowAsync
ウィンドウの位置に の 4
値を使用します。これは値を SW_RESTORE
表します。
ウィンドウを最大化するには、 を表す の 3
値を使用します SW_MAXIMIZE
。
パラメーター
-AssemblyName
型を含むアセンブリの名前を指定します。 Add-Type
は、指定したアセンブリから型を受け取ります。 このパラメーターは、アセンブリ名に基づいて型を作成する場合に必要です。
アセンブリの完全名または単純名 (部分名とも呼ばれます) を入力します。 アセンブリ名ではワイルドカード文字を使用できます。 単純または部分的な名前を入力した場合は、 Add-Type
完全な名前に解決し、完全な名前を使用してアセンブリを読み込みます。
Path パラメーターまたは LiteralPath パラメーターを使用すると、読み込む目的のアセンブリが読み込まれることが保証されます。 AssemblyName パラメーターを使用すると、PowerShell は標準の .NET アセンブリ解決プロセスを使用してアセンブリ名を解決するように .NET に要求します。 .NET は最初にアプリケーション フォルダーを検索するため、 Add-Type
現在のフォルダー内のバージョンではなく から $PSHOME
アセンブリを読み込む場合があります。 詳細については、「アセンブリの 場所」を参照してください。
.NET で名前の解決に失敗した場合、PowerShell は現在の場所を調べ、アセンブリを検索します。 AssemblyName パラメーターでワイルドカードを使用すると、.NET アセンブリ解決プロセスが失敗し、PowerShell が現在の場所を検索します。
Type: | String[] |
Aliases: | AN |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-CompilerOptions
ソース コード コンパイラのオプションを指定します。 これらのオプションは、リビジョンなしでコンパイラに送信されます。
このパラメーターを使用すると、実行可能ファイルの生成、リソースの埋め込み、コマンド ライン オプション (オプションなど) の設定をコンパイラに /unsafe
指示できます。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IgnoreWarnings
コンパイラの警告は無視します。 コンパイラ警告をエラーとして処理しないように Add-Type
するには、このパラメーターを使用します。
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Language
ソース コードで使用される言語を指定します。 このパラメーターに使用できる値は です CSharp
。
Type: | Language |
Accepted values: | CSharp |
Position: | Named |
Default value: | CSharp |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LiteralPath
型を含むソース コード ファイルまたはアセンブリ DLL ファイルへのパスを指定します。 Path とは異なり、LiteralPath パラメーターの値は、型指定されたとおりに使用されます。 ワイルドカードとして解釈される文字はありません。 パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。 一重引用符は、文字をエスケープ シーケンスとして解釈しないように PowerShell に指示します。
Path パラメーターまたは LiteralPath パラメーターを使用すると、読み込む目的のアセンブリが読み込まれることが保証されます。
Type: | String[] |
Aliases: | PSPath, LP |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MemberDefinition
クラスの新しいプロパティまたはメソッドを指定します。 Add-Type
は、プロパティまたはメソッドをサポートするために必要なテンプレート コードを生成します。
Windows では、この機能を使用して、PowerShell のアンマネージド関数に対してプラットフォーム呼び出し (P/Invoke) 呼び出しを行うことができます。
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
作成するクラスの名前を指定します。 メンバー定義から型を生成する場合は、このパラメーターは必須です。
型名と名前空間はセッション内で一意である必要があります。 型をアンロードしたり、変更したりすることはできません。 型のコードを変更するには、名前を変更するか、新しい PowerShell セッションを開始する必要があります。 それ以外の場合、コマンドは失敗します。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Namespace
型の名前空間を指定します。
このパラメーターがコマンドに含まれていない場合、型は Microsoft.PowerShell.Commands.AddType.AutoGeneratedTypes 名前空間に作成されます。 パラメーターが空の文字列値または の値 $Null
を持つコマンドに含まれている場合、型はグローバル名前空間で生成されます。
Type: | String |
Aliases: | NS |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OutputAssembly
その場所に指定した名前のアセンブリ DLL ファイルを生成します。 省略可能なパスとファイル名を入力します。 ワイルドカード文字を使用できます。 既定では、 Add-Type
はメモリ内でのみアセンブリを生成します。
Type: | String |
Aliases: | OA |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-OutputType
出力アセンブリの出力の種類を指定します。 既定では、出力の種類は指定されていません。 このパラメーターは、コマンドで出力アセンブリが指定されている場合にのみ有効です。 値の詳細については、「 OutputAssemblyType 列挙」を参照してください。
このパラメーターに使用できる値は次のとおりです。
ConsoleApplication
Library
WindowsApplication
重要
PowerShell 7.1 以降では、 はサポートされておらず、 ConsoleApplication
WindowsApplication
OutputType パラメーターの値としていずれかが指定されている場合、PowerShell は終了エラーをスローします。
Type: | OutputAssemblyType |
Aliases: | OT |
Accepted values: | ConsoleApplication, Library, WindowsApplication |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
追加された型を表す System.Runtime オブジェクトを返します。 既定では、このコマンドレットは出力を生成しません。
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Path
型を含むソース コード ファイルまたはアセンブリ DLL ファイルへのパスを指定します。
ソース コード ファイルを送信する場合は、 Add-Type
ファイル内のコードをコンパイルし、型のメモリ内アセンブリを作成します。 Path の値で指定されたファイル拡張子によって、使用するコンパイラがAdd-Type
決まります。
Path パラメーターまたは LiteralPath パラメーターを使用すると、読み込む目的のアセンブリが読み込まれることが保証されます。
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ReferencedAssemblies
型が依存しているアセンブリを指定します。 既定では、 Add-Type
は と を参照 System.dll
します System.Management.Automation.dll
。 既定のアセンブリに加え、このパラメーターを使用して指定されたアセンブリも参照されます。
PowerShell 6 以降、 ReferencedAssemblies には既定の .NET アセンブリは含まれていません。 このパラメーターに渡される値には、それらに対する特定の参照を含める必要があります。
Type: | String[] |
Aliases: | RA |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TypeDefinition
型定義を含むソース コードを指定します。 文字列またはヒア文字列のソース コードを入力するか、ソース コードを含む変数を入力します。 here-strings の詳細については、「 about_Quoting_Rules」を参照してください。
型定義に、名前空間宣言を含めます。 名前空間の宣言を省略すると、型が別の型または別の型のショートカットと同名となり、意図しない上書きを引き起こす場合があります。 たとえば、Exception という型を定義すると、System.Exception のショートカットとして Exception を使用するスクリプトは失敗します。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UsingNamespace
クラスに必要な他の名前空間を指定します。 これは、C# キーワード (keyword) Using
とよく似ています。
既定では、 Add-Type
は System 名前空間を参照します。 MemberDefinition パラメーターを使用する場合は、Add-Type
既定で System.Runtime.InteropServices 名前空間も参照します。 既定の名前空間に加え、UsingNamespace パラメーターを使用して追加された名前空間も参照されます。
Type: | String[] |
Aliases: | Using |
Position: | Named |
Default value: | System namespace |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
入力
None
オブジェクトをこのコマンドレットにパイプすることはできません。
出力
None
既定では、このコマンドレットは出力を返しません。
PassThru パラメーターを使用すると、このコマンドレットは新しい型を表す System.Type オブジェクトを返します。
メモ
追加した型は、現在のセッションのみに存在します。 すべてのセッションで型を使用するには、PowerShell プロファイルに追加します。 プロファイルの詳細については、「 about_Profiles」を参照してください。
型名と名前空間は、セッション内で一意である必要があります。 型をアンロードしたり、変更したりすることはできません。 型のコードを変更する必要がある場合は、名前を変更するか、新しい PowerShell セッションを開始する必要があります。 それ以外の場合、コマンドは失敗します。
Windows PowerShell (バージョン 5.1 以降) では、まだ読み込まれていないものに対して を使用Add-Type
する必要があります。 最も一般的に、これはグローバル アセンブリ キャッシュ (GAC) にあるアセンブリに適用されます。
PowerShell 6 以降では GAC がないため、PowerShell は 独自のアセンブリを に $PSHOME
インストールします。
これらのアセンブリは要求に応じて自動的に読み込まれるため、それらを読み込むのに使用 Add-Type
する必要はありません。 ただし、 を使用 Add-Type
すると、スクリプトが任意のバージョンの PowerShell と暗黙的に互換性を持つことができるようになります。
GAC 内のアセンブリは、パスではなく型名で読み込むことができます。 アセンブリを任意のパスから読み込むには、 が必要 Add-Type
です。これらのアセンブリを自動的に読み込むことはできません。