Partilhar via

Import-IseSnippet

  • Referência
Módulo:
ISE

Importa trechos do ISE para a sessão atual

Sintaxe

Import-IseSnippet
      [-Path] <String>
      [-Recurse]
      [<CommonParameters>]
Import-IseSnippet
      [-Recurse]
      -Module <String>
      [-ListAvailable]
      [<CommonParameters>]

Description

O Import-IseSnippet cmdlet importa "trechos" de texto reutilizáveis de um módulo ou diretório para a sessão atual. Os trechos estão imediatamente disponíveis para uso no Windows PowerShell ISE. Este cmdlet funciona somente no ISE (Ambiente de Script Integrado) do Windows PowerShell.

Para exibir e usar os trechos importados, no menu Editar ISE do Windows PowerShell, clique em Iniciar Trechos ou pressione Ctrl+J.

Trechos importados estão disponíveis somente na sessão atual. Para importar os trechos para todas as sessões ISE do Windows PowerShell, adicione um Import-IseSnippet comando ao seu perfil do Windows PowerShell ou copie os arquivos de trechos para o diretório $HOME\Documents\WindowsPowershell\Snippetsde trechos local.

Para importar trechos, eles devem ser formatados corretamente no trecho XML para trechos ISE do Windows PowerShell e salvos em arquivos Snippet.ps1xml. Para criar trechos qualificados, use o New-IseSnippet cmdlet. New-IseSnippet Cria um <SnippetTitle>.Snippets.ps1xml arquivo no $HOME\Documents\WindowsPowerShell\Snippets diretório. Você pode mover ou copiar os trechos para o diretório Trechos de um módulo do Windows PowerShell ou para qualquer outro diretório.

O Get-IseSnippet cmdlet, que obtém trechos criados pelo usuário no diretório local de trechos, não recebe trechos importados.

Este cmdlet foi introduzido no Windows PowerShell 3.0.

Exemplos

Exemplo 1: Importar trechos de um diretório

Este exemplo importa os trechos do \\Server01\Public\Snippets diretório para a sessão atual. Ele usa o parâmetro Recurse para obter trechos de todos os subdiretórios do diretório Snippets.

Import-IseSnippet -Path \\Server01\Public\Snippets -Recurse

Exemplo 2: Importar trechos de um módulo

Este exemplo importa os trechos do módulo SnippetModule . O comando usa o parâmetro ListAvailable para importar os trechos, mesmo que o módulo SnippetModule não seja importado para a sessão do usuário quando o comando é executado.

Import-IseSnippet -Module SnippetModule -ListAvailable

Exemplo 3: Localizar trechos em módulos

Este exemplo obtém trechos em todos os módulos instalados na variável de ambiente PSModulePath .

($env:PSModulePath).split(";") |
  ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} |
    ForEach-Object {$_.fullname}

Exemplo 4: Importar todos os trechos de módulo

Este exemplo importa todos os trechos de todos os módulos instalados para a sessão atual. Normalmente, você não precisa executar um comando como este porque os módulos que têm trechos usarão o Import-IseSnippet cmdlet para importá-los para você quando o módulo for importado.

($env:PSModulePath).split(";") |
  ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} |
    ForEach-Object {$psise.CurrentPowerShellTab.Snippets.Load($_)}

Exemplo 5: Copiar todos os trechos de módulo

Este exemplo copia os arquivos de snippet de todos os módulos instalados para o Snippets diretório do usuário atual. Ao contrário dos trechos importados, que afetam apenas a sessão atual, os trechos copiados estão disponíveis em todas as sessões ISE do Windows PowerShell.

($env:PSModulePath).split(";") |
  ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} |
    Copy-Item -Destination $HOME\Documents\WindowsPowerShell\Snippets

Parâmetros

-ListAvailable

Indica que esse cmdlet obtém trechos de módulos instalados no computador, mesmo que os módulos não sejam importados para a sessão atual. Se esse parâmetro for omitido e o módulo especificado pelo parâmetro Module não for importado para a sessão atual, a tentativa de obter os trechos do módulo falhará.

Este parâmetro é válido somente quando o parâmetro Module é usado no comando.

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

-Module

Importa trechos do módulo especificado para a sessão atual. Não há suporte para caracteres curinga.

Este parâmetro importa trechos de Snippet.ps1xml arquivos no subdiretório Trechos no caminho do módulo, como $HOME\Documents\WindowsPowerShell\Modules\<ModuleName>\Snippets.

Este parâmetro foi projetado para ser usado por autores de módulo em um script de inicialização, como um script especificado na chave ScriptsToProcess de um manifesto de módulo. Trechos em um módulo não são importados automaticamente com o módulo, mas você pode usar um Import-IseSnippet comando para importá-los.

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

-Path

Especifica o caminho para o diretório de trechos no qual esse cmdlet importa trechos.

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

-Recurse

Indica que esse cmdlet importa trechos de todos os subdiretórios do valor do parâmetro Path .

Tipo:SwitchParameter
Position:Named
Default value:None
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

Este cmdlet não retorna nenhuma saída.

Notas

  • Não é possível usar o Get-IseSnippet cmdlet para obter trechos importados. Get-IseSnippet Obtém apenas trechos no $HOME\Documents\WindowsPowerShell\Snippets diretório.

  • Import-IseSnippet usa o método estático Load dos objetos Microsoft.PowerShell.Host.ISE.ISESnippetCollection . Você também pode usar o método Load de trechos no modelo de objeto ISE do Windows PowerShell: $psISE.CurrentPowerShellTab.Snippets.Load()

  • O New-IseSnippet cmdlet armazena novos trechos criados pelo usuário em arquivos .ps1xml não assinados. Como tal, o Windows PowerShell não pode carregá-los em uma sessão na qual a política de execução é AllSigned ou Restricted. Em uma sessão Restrita ou AllSigned , você pode criar, obter e importar trechos não assinados criados pelo usuário, mas não pode usá-los na sessão.

    Para usar trechos não assinados criados pelo usuário que o Import-IseSnippet cmdlet retorna, altere a política de execução e reinicie o Windows PowerShell ISE.

    Para obter mais informações sobre as políticas de execução do Windows PowerShell, consulte about_Execution_Policies.