Add-Type

Referência

Módulo:: Microsoft.PowerShell.Utility

Adiciona uma classe Microsoft .NET a uma sessão do PowerShell.

Sintaxe

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

Description

O cmdlet Add-Type permite definir uma classe Microsoft .NET Core em sua sessão do PowerShell. Em seguida, você pode instanciar objetos, usando o cmdlet New-Object, e usar os objetos da mesma forma que usaria qualquer objeto .NET Core. Se você adicionar um comando Add-Type ao seu perfil do PowerShell, a classe estará disponível em todas as sessões do PowerShell.

Você pode especificar o tipo especificando um assembly existente ou arquivos de código-fonte, ou pode especificar o código-fonte embutido ou salvo em uma variável. Você pode até mesmo especificar apenas um método e Add-Type define e gera a classe. No Windows, você pode usar esse recurso para fazer chamadas Platform Invoke (P/Invoke) para funções não gerenciadas no PowerShell. Se você especificar o código-fonte, Add-Type compilará o código-fonte especificado e gerará um assembly na memória que contém os novos tipos do .NET Core.

Você pode usar os parâmetros de Add-Type para especificar uma linguagem alternativa e um compilador, C# é o padrão, opções do compilador, dependências de assembly, o namespace de classe, os nomes do tipo e o assembly resultante.

A partir do PowerShell 7, Add-Type não compila um tipo se já existir um tipo com o mesmo nome. Além disso, Add-Type procura assemblies em uma pasta ref na pasta que contém pwsh.dll.

Exemplos

Exemplo 1: Adicionar um tipo .NET a uma sessão

Este exemplo adiciona a classe BasicTest à sessão especificando o código-fonte armazenado em uma variável. A classe BasicTest é usada para adicionar inteiros, criar um objeto e multiplicar inteiros.

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

A variável $Source armazena o código-fonte da classe. O tipo tem um método estático chamado Add e um método não estático chamado Multiply.

O cmdlet Add-Type adiciona a classe à sessão. Como está usando código-fonte embutido, o comando usa o parâmetro TypeDefinition para especificar o código na variável $Source.

O método estático Add da classe BasicTest usa os caracteres de dois pontos duplos (::) para especificar um membro estático da classe. Os inteiros são adicionados e a soma é exibida.

O cmdlet New-Object instancia uma instância da classe BasicTest. Ele salva o novo objeto na variável $BasicTestObject.

$BasicTestObject usa o método Multiply. Os inteiros são multiplicados e o produto é exibido.

Exemplo 2: Examinar um tipo adicionado

Este exemplo usa o cmdlet Get-Member para examinar os objetos que os cmdlets Add-Type e New-Object criaram no Exemplo 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()

O cmdlet Get-Member obtém o tipo e os membros da classe BasicTest do que Add-Type adicionados à sessão. O comando Get-Member revela que é um objeto System.RuntimeType, que é derivado da classe System.Object.

O parâmetro Get-MemberStatic obtém as propriedades estáticas e os métodos da classe BasicTest. A saída mostra que o método Add está incluído.

O cmdlet Get-Member obtém os membros do objeto armazenados na variável $BasicTestObject. $BasicTestObject foi criado usando o cmdlet New-Object com a classe BasicTest. A saída revela que o valor da variável $BasicTestObject é uma instância da classe BasicTest e que inclui um membro chamado Multiply.

Exemplo 3: Adicionar tipos de um assembly

Este exemplo adiciona as classes do assembly JsonSchema.NET.dll à sessão atual.

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

Set-Location usa o parâmetro Path para especificar a variável $PSHOME. A variável faz referência ao diretório de instalação do PowerShell onde o arquivo DLL está localizado.

A variável $AccType armazena um objeto criado com o cmdlet Add-Type. Add-Type usa o parâmetro AssemblyName para especificar o nome do assembly. O caractere curinga asterisco (*) permite que você obtenha a montagem correta, mesmo quando você não tem certeza do nome ou de sua ortografia. O parâmetro PassThru gera objetos que representam as classes que são adicionadas à sessão.

Exemplo 4: Chamar APIs nativas do Windows

Este exemplo demonstra como chamar APIs nativas do Windows no PowerShell. Add-Type usa o mecanismo Platform Invoke (P/Invoke) para chamar uma função em User32.dll do PowerShell. Este exemplo só funciona em computadores que executam o sistema operacional 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)

A variável $Signature armazena a assinatura C# da função ShowWindowAsync. Para garantir que o método resultante esteja visível em uma sessão do PowerShell, a palavra-chave public foi adicionada à assinatura padrão. Para obter mais informações, consulte função ShowWindowAsync.

A variável $ShowWindowAsync armazena o objeto criado pelo parâmetro Add-TypePassThru. O cmdlet Add-Type adiciona a função ShowWindowAsync à sessão do PowerShell como um método estático. O comando usa o parâmetro MemberDefinition para especificar a definição de método salva na variável $Signature. O comando usa os parâmetros Name e Namespace para especificar um nome e um namespace para a classe. O parâmetro PassThru gera um objeto que representa os tipos.

O novo método estático ShowWindowAsync é usado nos comandos para minimizar e restaurar o console do PowerShell. O método usa dois parâmetros: o identificador de janela e um inteiro que especifica como a janela é exibida.

Para minimizar o console do PowerShell, ShowWindowAsync usa o cmdlet Get-Process com a variável automática $PID para obter o processo que está hospedando a sessão atual do PowerShell. Em seguida, ele usa o MainWindowHandle propriedade do processo atual e um valor de 2, que representa o valor SW_MINIMIZE.

Para restaurar a janela, ShowWindowAsync usa um valor de 4 para a posição da janela, que representa o valor SW_RESTORE.

Para maximizar a janela, use o valor de 3 que representa SW_MAXIMIZE.

Parâmetros

-AssemblyName

Especifica o nome de um assembly que inclui os tipos. Add-Type usa os tipos do assembly especificado. Esse parâmetro é necessário quando você está criando tipos com base em um nome de assembly.

Insira o nome completo ou simples, também conhecido como nome parcial, de um assembly. Caracteres curinga são permitidos no nome do assembly. Se você inserir um nome simples ou parcial, Add-Type o resolverá para o nome completo e, em seguida, usará o nome completo para carregar o assembly.

O uso dos parâmetros Path ou LiteralPath garante que você está carregando o assembly que pretendia carregar. Quando você usa o parâmetro AssemblyName, o PowerShell solicita ao .NET para resolver o nome do assembly usando o processo de resolução de assembly .NET padrão. Como o .NET pesquisa a pasta do aplicativo primeiro, Add-Type pode carregar um assembly do $PSHOME em vez da versão na pasta atual. Para obter mais informações, consulte Local do assembly.

Se o .NET não conseguir resolver o nome, o PowerShell procurará no local atual para localizar o assembly. Quando você usa curingas no parâmetro AssemblyName, o processo de resolução de assembly .NET falha fazendo com que o PowerShell procure no local atual.

Tipo:	String[]
Aliases:	AN
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	True

-CompilerOptions

Especifica as opções para o compilador de código-fonte. Essas opções são enviadas para o compilador sem revisão.

Esse parâmetro permite direcionar o compilador para gerar um arquivo executável, incorporar recursos ou definir opções de linha de comando, como a opção /unsafe.

Tipo:	String[]
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-IgnoreWarnings

Ignora os avisos do compilador. Use esse parâmetro para impedir que Add-Type manipule avisos do compilador como erros.

Tipo:	SwitchParameter
Position:	Named
Default value:	False
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Language

Especifica o idioma usado no código-fonte. O valor aceitável para este parâmetro é CSharp.

Tipo:	Language
Valores aceites:	CSharp
Position:	Named
Default value:	CSharp
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-LiteralPath

Especifica o caminho para arquivos de código-fonte ou arquivos DLL de assembly que contêm os tipos. Ao contrário Path, o valor do parâmetro LiteralPath é usado exatamente como é digitado. Nenhum caractere é interpretado como curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. Aspas simples dizem ao PowerShell para não interpretar nenhum caractere como sequências de escape.

O uso dos parâmetros Path ou LiteralPath garante que você está carregando o assembly que pretendia carregar.

Tipo:	String[]
Aliases:	PSPath, LP
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-MemberDefinition

Especifica novas propriedades ou métodos para a classe. Add-Type gera o código de modelo necessário para dar suporte às propriedades ou métodos.

No Windows, você pode usar esse recurso para fazer chamadas Platform Invoke (P/Invoke) para funções não gerenciadas no PowerShell.

Tipo:	String[]
Position:	1
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Name

Especifica o nome da classe a ser criada. Este parâmetro é necessário ao gerar um tipo a partir de uma definição de membro.

O nome do tipo e o namespace devem ser exclusivos dentro de uma sessão. Não é possível descarregar um tipo ou alterá-lo. Para alterar o código de um tipo, você deve alterar o nome ou iniciar uma nova sessão do PowerShell. Caso contrário, o comando falhará.

Tipo:	String
Position:	0
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Namespace

Por padrão, esse comando cria o tipo no namespace Microsoft.PowerShell.Commands.AddType.AutoGeneratedTypes. Quando você usa esse parâmetro, o tipo é criado no namespace especificado. Se o valor for uma cadeia de caracteres vazia, o tipo será criado no namespace global.

Tipo:	String
Aliases:	NS
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-OutputAssembly

Gera um arquivo DLL para o assembly com o nome especificado no local. Insira um caminho e um nome de arquivo opcionais. Caracteres curinga são permitidos. Por padrão, Add-Type gera o assembly somente na memória. Se você enviar o assembly para um arquivo, deverá incluir o parâmetro PassThru para retornar o tipo do assembly recém-criado.

Tipo:	String
Aliases:	OA
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	True

-OutputType

Especifica o tipo de saída do assembly de saída. Por padrão, nenhum tipo de saída é especificado. Este parâmetro é válido somente quando um assembly de saída é especificado no comando. Para obter mais informações sobre os valores, consulte OutputAssemblyType Enumeration.

Os valores aceitáveis para este parâmetro são os seguintes:

ConsoleApplication
Library
WindowsApplication

Importante

A partir do PowerShell 7.1, ConsoleApplication e WindowsApplication não são suportados e o PowerShell lança um erro de encerramento se ambos forem especificados como valores para o parâmetro OutputType.

Tipo:	OutputAssemblyType
Aliases:	OT
Valores aceites:	ConsoleApplication, Library, WindowsApplication
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-PassThru

Retorna um objeto System.Runtime que representa os tipos que foram adicionados. Por padrão, esse cmdlet não gera nenhuma saída. Use esse parâmetro se você usou OutputAssembly para criar um arquivo DLL e deseja retornar o tipo do assembly recém-criado.

Tipo:	SwitchParameter
Position:	Named
Default value:	False
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Path

Especifica o caminho para arquivos de código-fonte ou arquivos DLL de assembly que contêm os tipos.

Se você enviar arquivos de código-fonte, Add-Type compilará o código nos arquivos e criará um assembly na memória dos tipos. A extensão de arquivo especificada no valor de Path determina o compilador que Add-Type usa.

O uso dos parâmetros Path ou LiteralPath garante que você está carregando o assembly que pretendia carregar.

Tipo:	String[]
Position:	0
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-ReferencedAssemblies

Especifica os assemblies dos quais o tipo depende. Por padrão, Add-Type referências System.dll e System.Management.Automation.dll. A partir do PowerShell 6, ReferencedAssemblies não inclui os assemblies .NET padrão. Você deve incluir uma referência específica a eles no valor passado para esse parâmetro.

Tipo:	String[]
Aliases:	RA
Position:	Named
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-TypeDefinition

Especifica o código-fonte que contém as definições de tipo. Insira o código-fonte em uma string ou here-string, ou insira uma variável que contenha o código-fonte. Para obter mais informações sobre here-strings, consulte about_Quoting_Rules.

Inclua uma declaração de namespace em sua definição de tipo. Se você omitir a declaração de namespace, seu tipo pode ter o mesmo nome que outro tipo ou o atalho para outro tipo, causando uma substituição não intencional. Por exemplo, se você definir um tipo chamado Exception, os scripts que usam Exception como atalho para System.Exception falharão.

Tipo:	String
Position:	0
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-UsingNamespace

Especifica outros namespaces que são necessários para a classe. Isso é muito parecido com a palavra-chave C#, Using.

Por padrão, Add-Type faz referência ao namespace System. Quando o parâmetro MemberDefinition é usado, Add-Type também faz referência ao namespace System.Runtime.InteropServices por padrão. Os namespaces que você adiciona usando o parâmetro UsingNamespace são referenciados além dos namespaces padrão.

Tipo:	String[]
Aliases:	Using
Position:	Named
Default value:	System namespace
Necessário:	False
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

Entradas

None

Não é possível canalizar objetos para este cmdlet.

Saídas

None

Por padrão, esse cmdlet não retorna nenhuma saída.

Type

Quando você usa o parâmetro PassThru, esse cmdlet retorna um System.Type objeto que representa o novo tipo.

Notas

Os tipos que você adiciona existem somente na sessão atual. Para usar os tipos em todas as sessões, adicione-os ao seu perfil do PowerShell. Para obter mais informações sobre o perfil, consulte about_Profiles.

Os nomes de tipo e namespaces devem ser exclusivos dentro de uma sessão. Não é possível descarregar um tipo ou alterá-lo. Se precisar alterar o código de um tipo, altere o nome ou inicie uma nova sessão do PowerShell. Caso contrário, o comando falhará.

No Windows PowerShell (versão 5.1 e inferior), você precisa usáAdd-Type para qualquer coisa que ainda não esteja carregada. Mais comumente, isso se aplica a assemblies encontrados no GAC (Global Assembly Cache). No PowerShell 6 e superior, não há GAC, portanto, o PowerShell instala seus próprios assemblies no $PSHOME. Esses assemblies são carregados automaticamente mediante solicitação, portanto, não há necessidade de usáAdd-Type para carregá-los. No entanto, o uso do Add-Type ainda é permitido para permitir que os scripts sejam implicitamente compatíveis com qualquer versão do PowerShell.

Os assemblies no GAC podem ser carregados pelo nome do tipo, em vez de pelo caminho. Carregar assemblies de um caminho arbitrário requer Add-Type, já que esses assemblies não podem ser carregados automaticamente.

Partilhar via

Add-Type

Sintaxe

Description

Exemplos

Exemplo 1: Adicionar um tipo .NET a uma sessão

Exemplo 2: Examinar um tipo adicionado

Exemplo 3: Adicionar tipos de um assembly

Exemplo 4: Chamar APIs nativas do Windows

Parâmetros

-AssemblyName

-CompilerOptions

-IgnoreWarnings

-Language

-LiteralPath

-MemberDefinition

-Name

-Namespace

-OutputAssembly

-OutputType

-PassThru

-Path

-ReferencedAssemblies

-TypeDefinition

-UsingNamespace

Entradas

Saídas

Notas

Recursos adicionais

Partilhar via

Add-Type

Sintaxe

Description

Exemplos

Exemplo 1: Adicionar um tipo .NET a uma sessão

Exemplo 2: Examinar um tipo adicionado

Exemplo 3: Adicionar tipos de um assembly

Exemplo 4: Chamar APIs nativas do Windows

Parâmetros

-AssemblyName

-CompilerOptions

-IgnoreWarnings

-Language

-LiteralPath

-MemberDefinition

-Name

-Namespace

-OutputAssembly

-OutputType

-PassThru

-Path

-ReferencedAssemblies

-TypeDefinition

-UsingNamespace

Entradas

Saídas

Notas

Ligações Relacionadas

Recursos adicionais