Add-Type

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

Met de Add-Type cmdlet kunt u een Microsoft .NET Core-klasse definiëren in uw PowerShell-sessie. U kunt vervolgens objecten instantiëren met behulp van de cmdlet New-Object en de objecten op dezelfde manier gebruiken als elk .NET Core-object. Als u een Add-Type opdracht aan uw PowerShell-profiel toevoegt, is de klasse beschikbaar in alle PowerShell-sessies.

U kunt het type opgeven door een bestaande assembly- of broncodebestanden op te geven, of u kunt de broncode inline opgeven of opslaan in een variabele. U kunt zelfs alleen een methode opgeven en Add-Type definieert en genereert de klasse. In Windows kunt u deze functie gebruiken om P/Invoke-aanroepen (Platform Invoke) te maken naar niet-beheerde functies in PowerShell. Als u broncode opgeeft, Add-Type de opgegeven broncode compileert en een assembly in het geheugen genereert die de nieuwe .NET Core-typen bevat.

U kunt de parameters van Add-Type gebruiken om een alternatieve taal en compiler op te geven. C# is de standaardinstelling, compileropties, assemblyafhankelijkheden, de klassenaamruimte, de namen van het type en de resulterende assembly.

Vanaf PowerShell 7 compileert Add-Type geen type als er al een type met dezelfde naam bestaat. Add-Type zoekt ook naar assembly's in een ref map onder de map die pwsh.dllbevat.

In dit voorbeeld wordt de klasse BasicTest toegevoegd aan de sessie door broncode op te geven die is opgeslagen in een variabele. De klasse BasicTest wordt gebruikt om gehele getallen toe te voegen, een object te maken en gehele getallen te vermenigvuldigen.

$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)

De variabele $Source slaat de broncode voor de klasse op. Het type heeft een statische methode met de naam Add en een niet-statische methode met de naam Multiply.

De cmdlet Add-Type voegt de klasse toe aan de sessie. Omdat deze inlinebroncode gebruikt, gebruikt de opdracht de parameter TypeDefinition om de code in de $Source variabele op te geven.

De Add statische methode van de klasse BasicTest gebruikt de dubbele punttekens (::) om een statisch lid van de klasse op te geven. De gehele getallen worden toegevoegd en de som wordt weergegeven.

Met de New-Object-cmdlet wordt een exemplaar van de klasse BasicTest geïnstitueert. Het nieuwe object wordt opgeslagen in de variabele $BasicTestObject.

$BasicTestObject gebruikt de methode Multiply. De gehele getallen worden vermenigvuldigd en het product wordt weergegeven.

In dit voorbeeld wordt de cmdlet Get-Member gebruikt om de objecten te onderzoeken die de Add-Type en New-Object cmdlets die zijn gemaakt in voorbeeld 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()

Met de Get-Member-cmdlet worden het type en de leden van de klasse BasicTest ophaalt die Add-Type toegevoegd aan de sessie. De opdracht Get-Member laat zien dat het een System.RuntimeType-object is, dat is afgeleid van de klasse System.Object.

De parameter Get-MemberStatic haalt de statische eigenschappen en methoden van de klasse BasicTest op. De uitvoer laat zien dat de methode Add is opgenomen.

Met de cmdlet Get-Member worden de leden van het object opgehaald dat is opgeslagen in de variabele $BasicTestObject. $BasicTestObject is gemaakt met behulp van de New-Object-cmdlet met de klasse BasicTest. De uitvoer laat zien dat de waarde van de variabele $BasicTestObject een exemplaar is van de klasse BasicTest en dat deze een lid bevat met de naam Multiply.

In dit voorbeeld worden de klassen uit de JsonSchema.NET.dll assembly toegevoegd aan de huidige sessie.

Set-Location -Path $PSHOME
$AccType = Add-Type -AssemblyName *jsonschema* -PassThru

Set-Location gebruikt de parameter Path om de variabele $PSHOME op te geven. De variabele verwijst naar de Installatiemap van PowerShell waar het DLL-bestand zich bevindt.

Met de variabele $AccType wordt een object opgeslagen dat is gemaakt met de cmdlet Add-Type. Add-Type gebruikt de parameter AssemblyName om de naam van de assembly op te geven. Met het jokerteken (*) van het sterretje (*) kunt u de juiste assembly ophalen, zelfs wanneer u niet zeker weet of de naam of de spelling ervan is. De parameter PassThru genereert objecten die de klassen vertegenwoordigen die aan de sessie worden toegevoegd.

In dit voorbeeld ziet u hoe u systeemeigen Windows-API's aanroept in PowerShell. Add-Type gebruikt het mechanisme Platform Invoke (P/Invoke) om een functie aan te roepen in User32.dll vanuit PowerShell. Dit voorbeeld werkt alleen op computers met het Windows-besturingssysteem.

$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)

In de $Signature variabele wordt de C#-handtekening van de functie ShowWindowAsync opgeslagen. Om ervoor te zorgen dat de resulterende methode zichtbaar is in een PowerShell-sessie, is het trefwoord public toegevoegd aan de standaardhandtekening. Zie functie ShowWindowAsync voor meer informatie.

De variabele $ShowWindowAsync slaat het object op dat is gemaakt door de parameter Add-TypePassThru. De cmdlet Add-Type voegt de ShowWindowAsync-functie als statische methode toe aan de PowerShell-sessie. De opdracht gebruikt de parameter MemberDefinition om de methodedefinitie op te geven die is opgeslagen in de $Signature variabele. De opdracht maakt gebruik van de parameters name en naamruimte om een naam en naamruimte voor de klasse op te geven. De parameter PassThru genereert een object dat de typen vertegenwoordigt.

De nieuwe ShowWindowAsync statische methode wordt gebruikt in de opdrachten om de PowerShell-console te minimaliseren en te herstellen. De methode gebruikt twee parameters: de venstergreep en een geheel getal dat aangeeft hoe het venster wordt weergegeven.

Als u de PowerShell-console wilt minimaliseren, gebruikt ShowWindowAsync de cmdlet Get-Process met de automatische $PID variabele om het proces op te halen dat als host fungeert voor de huidige PowerShell-sessie. Vervolgens wordt de eigenschap MainWindowHandle van het huidige proces en een waarde van 2gebruikt, die de SW_MINIMIZE waarde vertegenwoordigt.

Als u het venster wilt herstellen, gebruikt ShowWindowAsync een waarde van 4 voor de vensterpositie, die de SW_RESTORE waarde vertegenwoordigt.

Als u het venster wilt maximaliseren, gebruikt u de waarde van 3 die SW_MAXIMIZEvertegenwoordigt.

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

U kunt geen objecten doorsluisen naar deze cmdlet.

Deze cmdlet retourneert standaard geen uitvoer.

Wanneer u de parameter PassThru gebruikt, retourneert deze cmdlet een System.Type-object dat het nieuwe type vertegenwoordigt.

De typen die u toevoegt, bestaan alleen in de huidige sessie. Als u de typen in alle sessies wilt gebruiken, voegt u deze toe aan uw PowerShell-profiel. Zie about_Profilesvoor meer informatie over het profiel.

Typenamen en naamruimten moeten uniek zijn binnen een sessie. U kunt een type niet verwijderen of wijzigen. Als u de code voor een type wilt wijzigen, moet u de naam wijzigen of een nieuwe PowerShell-sessie starten. Anders mislukt de opdracht.

In Windows PowerShell (versie 5.1 en lager) moet u Add-Type gebruiken voor alles wat nog niet is geladen. Dit geldt meestal voor assembly's die zijn gevonden in de Global Assembly Cache (GAC). In PowerShell 6 en hoger is er geen GAC, dus PowerShell installeert zijn eigen assembly's in $PSHOME. Deze assembly's worden automatisch op aanvraag geladen, dus u hoeft Add-Type niet te gebruiken om ze te laden. Het gebruik van Add-Type is echter nog steeds toegestaan om toe te staan dat scripts impliciet compatibel zijn met elke versie van PowerShell.

Assembly's in de GAC kunnen worden geladen op typenaam, in plaats van op pad. Het laden van assembly's van een willekeurig pad vereist Add-Type, omdat deze assembly's niet automatisch kunnen worden geladen.