New-IseSnippet

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

O cmdlet New-ISESnippet cria um texto reutilizável "snippet" para o ISE do Windows PowerShell. Você pode usar snippets de código para adicionar texto ao painel Script ou painel comando no ISE do Windows PowerShell. Esse cmdlet só está disponível no ISE do Windows PowerShell.

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

O cmdlet New-ISESnippet cria um arquivo <Title>.Snippets.ps1xml no diretório $HOME\Documents\WindowsPowerShell\Snippets 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 snippets criados pelo usuário em uma sessão na qual a política de execução é Restrito ou AllSigned.

Esse cmdlet foi introduzido no Windows PowerShell 3.0.

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

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

Esse comando cria um snippet de Comment-BasedHelp para o ISE do Windows PowerShell. Ele cria um arquivo chamado Comment-BasedHelp.snippets.ps1xml no diretório Snippets do usuário $HOME\Documents\WindowsPowerShell\Snippets.

$M = @'
param
(
  [Parameter(Mandatory=$true)]
  [string[]]
  $<ParameterName>
)
'@

$snippet = @{
    Text = $M
    Title = 'Mandatory'
    Description = 'Adds a mandatory function parameter.'
    Author = 'Patti Fuller, Fabrikam Corp.'
    Force = $true
}
New-ISESnippet @snippet

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

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

Esse comando usa o cmdlet Copy-Item para copiar o snippet de obrigatório da pasta em que New-ISESnippet o coloca no compartilhamento de arquivos Server\Share.

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.

Não é possível transferir objetos para esse cmdlet.

Esse cmdlet não retorna nenhuma saída.

New-IseSnippet armazena novos snippets criados pelo usuário em arquivos de .ps1xml sem sinal. Dessa forma, o Windows PowerShell não pode adicioná-los a uma sessão na qual a política de execução é AllSigned ou Restrito. Em uma sessão Restricted ou AllSigned, você pode criar, obter e importar snippets não assinados criados pelo usuário, mas não é possível usá-los na sessão.

Se você usar o cmdlet New-IseSnippet em um Restrito ou sessão allSigned, o snippet será criado, mas uma mensagem de erro será exibida quando o Windows PowerShell tentar adicionar o snippet recém-criado à sessão. Para usar o novo snippet (e outros snippets não assinados criados pelo usuário), altere a política de execução e reinicie o ISE do Windows PowerShell.

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

• Para alterar um snippet de código, edite o arquivo de snippet. Você pode editar arquivos de snippet no painel Script do ISE do Windows PowerShell.
• Para excluir um snippet que você adicionou, exclua o arquivo de snippet.
• Você não pode excluir um snippet interno, mas pode ocultar todos os snippets internos usando o comando "$psISE.Options.ShowDefaultSnippets=$false".
• Você pode criar um snippet que tenha o mesmo nome de um snippet interno. Ambos os snippets aparecem no menu de snippet no ISE do Windows PowerShell.