Partilhar via

New-IseSnippet

  • Referência
Módulo:
ISE

Cria um trecho de código ISE do Windows PowerShell.

Sintaxe

New-IseSnippet
   [-Title] <String>
   [-Description] <String>
   [-Text] <String>
   [-Author <String>]
   [-CaretOffset <Int32>]
   [-Force]
   [<CommonParameters>]

Description

O New-ISESnippet cmdlet cria um "trecho" de texto reutilizável para o Windows PowerShell ISE. Você pode usar trechos para adicionar texto ao painel Script ou ao Painel de comando no Windows PowerShell ISE. Este cmdlet está disponível somente no Windows PowerShell ISE.

A partir do Windows PowerShell 3.0, o Windows PowerShell ISE inclui uma coleção de trechos internos. O New-ISESnippet cmdlet permite criar seus próprios trechos para adicionar à coleção interna. Você pode exibir, alterar, adicionar, excluir e compartilhar arquivos de trechos e incluí-los nos módulos do Windows PowerShell. Para ver trechos no Windows PowerShell ISE, no menu Editar, selecione Iniciar trechos ou pressione CTRL+J.

O New-ISESnippet cmdlet cria um <Title>.Snippets.ps1xml arquivo no $HOME\Documents\WindowsPowerShell\Snippets diretório com o título especificado. Para incluir um arquivo de snippet em um módulo que você está criando, adicione o arquivo de snippet a um subdiretório Snippets do diretório do módulo.

Não é possível usar trechos criados pelo usuário em uma sessão na qual a política de execução é Restrita ou AllSigned.

Este cmdlet foi introduzido no Windows PowerShell 3.0.

Exemplos

Exemplo 1: Criar um trecho de ajuda baseado em comentários

New-IseSnippet -Title Comment-BasedHelp -Description "A template for comment-based help." -Text "<#
    .SYNOPSIS

    .DESCRIPTION
    .PARAMETER  <Parameter-Name>
    .INPUTS
    .OUTPUTS
    .EXAMPLE
    .LINK
#>"

Este comando cria um trecho de Ajuda Baseada em Comentários para o Windows PowerShell ISE. Ele cria um arquivo nomeado Comment-BasedHelp.snippets.ps1xml no diretório $HOME\Documents\WindowsPowerShell\SnippetsSnippets do usuário.

Exemplo 2: Criar um trecho obrigatório

$M = @'
Param
(
  [parameter(Mandatory=$true)]
  [String[]]
  $<ParameterName>
)
'@

New-ISESnippet -Text $M -Title Mandatory -Description "Adds a mandatory function parameter." -Author "Patti Fuller, Fabrikam Corp." -Force

Este exemplo cria um trecho chamado Mandatory for Windows PowerShell ISE. O primeiro comando salva o texto do trecho na $M variável. O segundo comando usa o New-ISESnippet cmdlet para criar o trecho. O comando usa o parâmetro Force para substituir um trecho anterior com o mesmo nome.

Exemplo 3: Copiar um trecho obrigatório de uma pasta para uma pasta de destino

Copy-Item "$HOME\Documents\WindowsPowerShell\Snippets\Mandatory.Snippets.ps1xml" -Destination "\\Server\Share"

Este comando usa o Copy-Item cmdlet para copiar o trecho obrigatório da pasta onde New-ISESnippet o coloca no compartilhamento de arquivos Server\Share.

Parâmetros

-Author

Especifica o autor do trecho. O campo autor aparece no arquivo de trecho, mas não aparece quando você clica no nome do trecho no Windows PowerShell ISE.

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

-CaretOffset

Especifica o caractere do texto do trecho no qual este cmdlet coloca o cursor. Insira um inteiro que represente a posição do cursor, com "1" representando o primeiro caractere do texto. O valor padrão, 0 (zero), coloca o cursor imediatamente antes do primeiro caractere do texto. Este parâmetro não recua o texto do trecho.

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

-Description

Especifica uma descrição do trecho. O valor da descrição aparece quando você clica no nome do trecho no Windows PowerShell ISE. Este parâmetro é obrigatório.

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

-Force

Indica que esse cmdlet substitui arquivos de snippet com o mesmo nome no mesmo local. Por padrão, New-ISESnippet não substitui arquivos.

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

-Text

Especifica o valor de texto que é adicionado quando você seleciona o trecho. O texto do trecho aparece quando você clica no nome do trecho no Windows PowerShell ISE. Este parâmetro é obrigatório.

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

-Title

Especifica um título ou nome para o trecho. O título também nomeia o arquivo de trecho. Este parâmetro é obrigatório.

Tipo:String
Position:1
Default value:None
Necessário:True
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

New-IseSnippet Armazena novos trechos criados pelo usuário em arquivos .ps1xml não assinados. Como tal, o Windows PowerShell não pode adicioná-los a 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.

Se você usar o New-IseSnippet cmdlet em uma sessão Restrita ou AllSigned , o trecho será criado, mas uma mensagem de erro será exibida quando o Windows PowerShell tentar adicionar o trecho recém-criado à sessão. Para usar o novo trecho (e outros trechos não assinados criados pelo usuário), 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.

  • Para alterar um trecho, edite o arquivo de trecho. Você pode editar arquivos de trechos no painel Script do Windows PowerShell ISE.
  • Para excluir um trecho que você adicionou, exclua o arquivo de trecho.
  • Não é possível excluir um trecho interno, mas você pode ocultar todos os trechos internos usando o "$psise. Comando Options.ShowDefaultSnippets=$false".
  • Você pode criar um trecho que tenha o mesmo nome de um trecho interno. Ambos os trechos aparecem no menu de trechos no Windows PowerShell ISE.