Partilhar via

Import-IseSnippet

Módulo:
ISE Module

Importa trechos do ISE para a sessão atual

Sintaxe

FromFolder (Predefinição) 

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

FromModule 

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

Description

O cmdlet Import-IseSnippet 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 Windows PowerShell ISE Editar, 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 comando Import-IseSnippet ao seu perfil do Windows PowerShell ou copie os arquivos de snippet para o diretório de trechos local $HOME\Documents\WindowsPowerShell\Snippets.

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 cmdlet New-IseSnippet. New-IseSnippet cria um arquivo <SnippetTitle>.Snippets.ps1xml no diretório $HOME\Documents\WindowsPowerShell\Snippets. 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 cmdlet Get-IseSnippet, que obtém trechos criados pelo usuário no diretório de trechos local, 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 diretório \\Server01\Public\Snippets 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 cmdlet Import-IseSnippet 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 trecho de todos os módulos instalados para o diretório Snippets 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.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

FromModule
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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 arquivos Snippet.ps1xml no subdiretório Trechos no caminho do módulo, como $HOME\Documents\WindowsPowerShell\Modules\<ModuleName>\Snippets.

Esse 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 comando Import-IseSnippet para importá-los.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

FromModule
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Path

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

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:True
NãoMostrar:False

Conjuntos de parâmetros

FromFolder
Position:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Recurse

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

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 cmdlet Get-IseSnippet para obter trechos importados. Get-IseSnippet obtém apenas trechos no diretório $HOME\Documents\WindowsPowerShell\Snippets.

  • Import-IseSnippet usa o Load método estático de objetos de 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 cmdlet New-IseSnippet 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 Restrito 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 cmdlet Import-IseSnippet 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.