Add-Type

語法

Add-Type
   [-CodeDomProvider <CodeDomProvider>]
   [-CompilerParameters <CompilerParameters>]
   [-TypeDefinition] <String>
   [-Language <Language>]
   [-ReferencedAssemblies <String[]>]
   [-OutputAssembly <String>]
   [-OutputType <OutputAssemblyType>]
   [-PassThru]
   [-IgnoreWarnings]
   [<CommonParameters>]

Add-Type
   [-CodeDomProvider <CodeDomProvider>]
   [-CompilerParameters <CompilerParameters>]
   [-Name] <String>
   [-MemberDefinition] <String[]>
   [-Namespace <String>]
   [-UsingNamespace <String[]>]
   [-Language <Language>]
   [-ReferencedAssemblies <String[]>]
   [-OutputAssembly <String>]
   [-OutputType <OutputAssemblyType>]
   [-PassThru]
   [-IgnoreWarnings]
   [<CommonParameters>]

Add-Type
   [-CompilerParameters <CompilerParameters>]
   [-Path] <String[]>
   [-ReferencedAssemblies <String[]>]
   [-OutputAssembly <String>]
   [-OutputType <OutputAssemblyType>]
   [-PassThru]
   [-IgnoreWarnings]
   [<CommonParameters>]

Add-Type
   [-CompilerParameters <CompilerParameters>]
   -LiteralPath <String[]>
   [-ReferencedAssemblies <String[]>]
   [-OutputAssembly <String>]
   [-OutputType <OutputAssemblyType>]
   [-PassThru]
   [-IgnoreWarnings]
   [<CommonParameters>]

Add-Type
   -AssemblyName <String[]>
   [-PassThru]
   [-IgnoreWarnings]
   [<CommonParameters>]

Description

Cmdlet Add-Type 可讓您在 PowerShell 工作階段中定義Microsoft .NET Framework 類別。 然後，您可以使用 Cmdlet 來具現化物件 New-Object ，並使用 物件，就像使用任何 .NET Framework 物件一樣。 如果您將命令新增 Add-Type 至 PowerShell 配置檔，則類別可在所有 PowerShell 會話中使用。

您可以指定現有的元件或原始碼檔案來指定類型，也可以指定內嵌或儲存在變數中的原始碼。 您甚至可以只指定方法，而且 Add-Type 會定義併產生 類別。 在 Windows 上，您可以使用這項功能，在 PowerShell 中對 Unmanaged 函式進行平台調用 （P/Invoke） 呼叫。 如果您指定原始程式碼， Add-Type 會編譯指定的原始程式碼，併產生包含新 .NET Framework 類型的記憶體內部元件。

您可以使用 的參數來指定替代語言和編譯程式 Add-Type ，C# 是預設值、編譯程式選項、元件相依性、類別命名空間、型別的名稱，以及產生的元件。

範例

範例 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的非靜態方法。

Cmdlet 會將 Add-Type 類別新增至會話。 因為它使用內嵌原始程式碼，所以命令會使用 TypeDefinition 參數來指定變數中的 $Source 程式代碼。

Add BasicTest 類別的靜態方法會使用雙冒號字元 （::） 來指定 類別的靜態成員。 會加入整數，並顯示總和。

Cmdlet 會New-Object具現化 BasicTest 類別的實例。 它會將新的物件儲存在變數中 $BasicTestObject 。

$BasicTestObjectMultiply會使用方法。 整數會相乘，並顯示產品。

範例 2：檢查新增的類型

此範例會Get-Member使用 Cmdlet 來檢查範例 1 中建立 的 Add-Type 和 New-Object Cmdlet 物件。

[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()

Cmdlet Get-Member 會取得新增至會話之 BasicTest 類別 Add-Type 的類型和成員。 此命令Get-Member會顯示它是 System.RuntimeType 物件，該物件衍生自 System.Object 類別。

Get-Member Static 參數會取得 BasicTest 類別的靜態屬性和方法。 輸出會顯示 Add 包含方法。

Cmdlet Get-Member 會取得儲存在 變數中的 $BasicTestObject 物件成員。 $BasicTestObject 是使用 New-Object Cmdlet 搭配 BasicTest 類別所建立。 輸出會顯示變數的值$BasicTestObject是 BasicTest 類別的實例，而且其中包含名為Multiply的成員。

範例 3：從元件新增類型

這個範例會將元件中的 Accessibility.dll 類別新增至目前的會話。

$AccType = Add-Type -AssemblyName "accessib*" -PassThru

變數 $AccType 會儲存使用 Add-Type Cmdlet 建立的物件。 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變數會儲存函式的 ShowWindowAsync C# 簽章。 為了確保產生的方法會顯示在PowerShell工作階段中， public 關鍵詞已新增至標準簽章。 如需詳細資訊，請參閱 ShowWindowAsync 函式。

變數$ShowWindowAsync會儲存 PassThru 參數所Add-Type建立的物件。 Cmdlet 會將 Add-Type 函式新增 ShowWindowAsync 至 PowerShell 會話做為靜態方法。 此命令會使用 MemberDefinition 參數來指定儲存在變數中的 $Signature 方法定義。 此命令會 使用 Name 和 Namespace 參數來指定 類別的名稱和命名空間。 PassThru 參數會產生代表型別的物件。

新的 ShowWindowAsync 靜態方法會用於命令中，以最小化和還原PowerShell控制台。 方法會採用兩個參數：視窗句柄，以及指定窗口顯示方式的整數。

若要將PowerShell控制台最小化， ShowWindowAsync 請使用 Get-Process Cmdlet 搭配 $PID 自動變數來取得裝載目前 PowerShell 會話的程式。 然後，它會使用 目前進程的 MainWindowHandle 屬性和 2的值，代表 SW_MINIMIZE 值。

若要還原視窗， ShowWindowAsync 請使用 4 的值作為視窗位置，代表 SW_RESTORE 值。

若要最大化視窗，請使用 表示SW_MAXIMIZE的 值3。

範例 5：從 Visual Basic 檔案新增類型

這個範例會Add-Type使用 Cmdlet，將檔案中Hello.vb定義的 VBFromFile 類別新增至目前的會話。 檔案的 Hello.vb 文字會顯示在命令輸出中。

Add-Type -Path "C:\PS-Test\Hello.vb"
[VBFromFile]::SayHello(", World")

# From Hello.vb

Public Class VBFromFile
  Public Shared Function SayHello(sourceName As String) As String
    Dim myValue As String = "Hello"
    return myValue + sourceName
  End Function
End Class

Hello, World

Add-Type會使用 Path 參數來指定來源檔案 ，Hello.vb並新增檔案中定義的類型。 函SayHello式會呼叫為 VBFromFile 類別的靜態方法。

範例 6：新增具有 JScript.NET 的類別

此範例會使用 JScript.NET，在 PowerShell 會話中建立新的類別 FRectangle。

Add-Type @'
 class FRectangle {
   var Length : double;
   var Height : double;
   function Perimeter() : double {
       return (Length + Height) * 2; }
   function Area() : double {
       return Length * Height;  } }
'@ -Language JScript

$rect = [FRectangle]::new()
$rect

Length Height
------ ------
     0      0

範例 7：新增 F# 編譯程式

此範例示範如何使用 Add-Type Cmdlet 將 F# 程式代碼編譯程式新增至 PowerShell 會話。 若要在 PowerShell 中執行此範例，您必須具有 FSharp.Compiler.CodeDom.dll 與 F# 語言一起安裝的 。

Add-Type -Path "FSharp.Compiler.CodeDom.dll"
$Provider = New-Object Microsoft.FSharp.Compiler.CodeDom.FSharpCodeProvider
$FSharpCode = @"
let rec loop n =if n <= 0 then () else beginprint_endline (string_of_int n);loop (n-1)end
"@
$FSharpType = Add-Type -TypeDefinition $FSharpCode -CodeDomProvider $Provider -PassThru |
   Where-Object { $_.IsPublic }
$FSharpType::loop(4)

4
3
2
1

Add-Type會使用Path參數來指定元件，並取得元件中的類型。 New-Object 會建立 F# 程式代碼提供者的實例，並將結果儲存在變數中 $Provider 。 變數會$FSharpCode儲存定義 Loop 方法的 F# 程式代碼。

變數 $FSharpType 會儲存 Cmdlet 的結果 Add-Type ，以儲存 中所 $FSharpCode定義的公用類型。 TypeDefinition 參數會指定定義型別的原始程式碼。 CodeDomProvider 參數會指定原始程式碼編譯程式。 PassThru 參數會指示Add-Type傳回代表型別的 Runtime 物件。 物件會向下傳送至 Where-Object Cmdlet，而 Cmdlet 只會傳回公用類型。 Cmdlet Where-Object 會使用，因為 F# 提供者會產生非公用類型，以支援產生的公用類型。

迴圈方法會呼叫為儲存在變數中 $FSharpType 之類型的靜態方法。

參數

-AssemblyName

-CodeDomProvider

-CompilerParameters

-IgnoreWarnings

-Language

-LiteralPath

-MemberDefinition

-Name

-Namespace

-OutputAssembly

-OutputType

-PassThru

-Path

-ReferencedAssemblies

-TypeDefinition

-UsingNamespace

輸入

None

您無法使用管線將物件傳送至此 Cmdlet。

輸出

None

根據預設，此 Cmdlet 不會傳回任何輸出。

Type

當您使用 PassThru 參數時，這個 Cmdlet 會 傳回代表新類型的 System.Type 物件。

備註

您新增的類型只存在於目前的工作階段中。 若要在所有工作階段中使用類型，請將這些類型新增至 PowerShell 配置檔。 如需配置檔的詳細資訊，請參閱 about_Profiles。

類型名稱和命名空間在會話內必須是唯一的。 您無法卸除類型或加以變更。 如果您需要變更類型的程式代碼，您必須變更名稱或啟動新的 PowerShell 工作階段。 否則，命令會失敗。

某些語言的 CodeDomProvider 類別，例如 IronPython 和 J#，不會產生輸出。 因此，以這些語言撰寫的類型無法搭配 Add-Type使用。

此 Cmdlet 是以 .NET Framework CodeDomProvider 類別Microsoft為基礎。

相關連結

• about_Profiles
• about_Quoting_Rules
• Add-Member
• New-Object
• OutputAssemblyType
• 平台叫用 (P/Invoke)
• Where-Object