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

Командлет Add-Type позволяет определить класс Microsoft .NET Core в сеансе PowerShell. Затем можно создать экземпляры объектов с помощью командлета New-Object и использовать объекты так же, как и любой объект .NET Core. При добавлении команды Add-Type в профиль PowerShell класс доступен во всех сеансах PowerShell.

Тип можно указать, указав существующие сборки или файлы исходного кода, или указать встроенный или сохраненный в переменной исходный код. Можно даже указать только метод и Add-Type определяет и создает класс. В Windows эту функцию можно использовать для вызова платформенного вызова (P/Invoke) неуправляемых функций в PowerShell. Если указать исходный код, Add-Type компилирует указанный исходный код и создает сборку в памяти, содержащую новые типы .NET Core.

Параметры Add-Type можно использовать для указания альтернативного языка и компилятора, C# — это параметры компилятора, зависимости сборок, пространство имен класса, имена типа и результирующая сборка.

Начиная с PowerShell 7, Add-Type не компилирует тип, если тип с тем же именем уже существует. Кроме того, Add-Type ищет сборки в папке ref в папке, содержащей pwsh.dll.

В этом примере в сеанс добавляется класс 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.

Статический метод AddBasicTest использует символы двойной двоеточия (::) для указания статического элемента класса. Добавляются целые числа и отображается сумма.

Командлет New-Object создает экземпляр класса BasicTest. Он сохраняет новый объект в переменной $BasicTestObject.

$BasicTestObject использует метод Multiply. Целые числа умножаются и отображается продукт.

В этом примере используется командлет Get-Member для проверки объектов, созданных Add-Type и командлетов New-Object, созданных в примере 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.RuntimeType, производный от класса System.Object.

Параметр Get-Memberstatic получает статические свойства и методы класса BasicTest. В выходных данных показано, что включен метод Add.

Командлет Get-Member получает члены объекта, хранящегося в переменной $BasicTestObject. $BasicTestObject был создан с помощью командлета New-Object с классом BasicTest. Выходные данные показывают, что значение переменной $BasicTestObject является экземпляром класса BasicTest и включает в себя элемент с именем Multiply.

В этом примере классы из сборки JsonSchema.NET.dll добавляются в текущий сеанс.

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

Set-Location использует параметр пути для указания переменной $PSHOME. Переменная ссылается на каталог установки PowerShell, где находится DLL-файл.

Переменная $AccType сохраняет объект, созданный с помощью командлета Add-Type. Add-Type использует параметр AssemblyName для указания имени сборки. Подстановочный знак звездочки (*) позволяет получить правильную сборку, даже если вы не уверены в имени или его орфографии. Параметр PassThru создает объекты, представляющие классы, добавленные в сеанс.

В этом примере показано, как вызывать собственные API Windows в PowerShell. Add-Type использует механизм вызова платформы (P/Invoke) для вызова функции в User32.dll из PowerShell. Этот пример работает только на компьютерах под управлением операционной системы 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 было добавлено в стандартную подпись. Дополнительные сведения см. в функции ShowWindowAsync.

Переменная $ShowWindowAsync сохраняет объект, созданный параметром Add-TypePassThru. Командлет Add-Type добавляет функцию ShowWindowAsync в сеанс PowerShell в качестве статического метода. Команда использует параметр MemberDefinition, чтобы указать определение метода, сохраненное в переменной $Signature. Команда использует параметры имени и пространства имен , чтобы указать имя и пространство имен для класса. Параметр PassThru создает объект, представляющий типы.

Новый ShowWindowAsync статический метод используется в командах для минимизации и восстановления консоли PowerShell. Метод принимает два параметра: дескриптор окна и целое число, указывающее, как отображается окно.

Чтобы свести к минимуму консоль PowerShell, ShowWindowAsync использует командлет Get-Process с автоматической переменной $PID, чтобы получить процесс, на котором размещен текущий сеанс PowerShell. Затем он использует свойство MainWindowHandle текущего процесса и значение 2, представляющее значение SW_MINIMIZE.

Чтобы восстановить окно, ShowWindowAsync использует значение 4 для положения окна, представляющего значение SW_RESTORE.

Чтобы развернуть окно, используйте значение 3, представляющее SW_MAXIMIZE.

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Невозможно передать объекты в этот командлет.

По умолчанию этот командлет не возвращает выходные данные.

При использовании параметра 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, так как эти сборки не могут загружаться автоматически.