New-IseSnippet

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

Cmdleten New-ISESnippet skapar ett återanvändbart textfragment för Windows PowerShell ISE. Du kan använda kodfragment för att lägga till text i skriptfönstret eller kommandofönstret i Windows PowerShell ISE. Den här cmdleten är endast tillgänglig i Windows PowerShell ISE.

Från och med Windows PowerShell 3.0 innehåller Windows PowerShell ISE en samling inbyggda kodfragment. Med cmdleten New-ISESnippet kan du skapa egna kodfragment att lägga till i den inbyggda samlingen. Du kan visa, ändra, lägga till, ta bort och dela kodfragmentfiler och inkludera dem i Windows PowerShell-moduler. Om du vill se kodfragment i Windows PowerShell ISE går du till menyn Redigera, väljer Starta kodfragment eller trycker på CTRL+J.

Cmdleten New-ISESnippet skapar en <Title>.Snippets.ps1xml fil i katalogen $HOME\Documents\WindowsPowerShell\Snippets med den rubrik som du anger. Om du vill inkludera en kodfragmentfil i en modul som du redigerar lägger du till kodfragmentfilen i en underkatalog för kodfragment i modulkatalogen.

Du kan inte använda användarskapade kodfragment i en session där körningsprincipen är Begränsad eller AllSigned.

Den här cmdleten introducerades i 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
#>"

Det här kommandot skapar ett Comment-BasedHelp kodfragment för Windows PowerShell ISE. Den skapar en fil med namnet Comment-BasedHelp.snippets.ps1xml i användarens kodfragmentkatalog $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

I det här exemplet skapas ett kodfragment med namnet Obligatorisk för Windows PowerShell ISE. Det första kommandot sparar kodfragmenttexten i variabeln $M. Det andra kommandot använder cmdleten New-ISESnippet för att skapa kodfragmentet. Kommandot använder parametern Force för att skriva över ett tidigare kodfragment med samma namn.

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

Det här kommandot använder cmdleten Copy-Item för att kopiera obligatoriskt-kodfragment från mappen där New-ISESnippet placerar det på filresursen Server\Share.

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Du kan inte skicka objekt till den här cmdleten.

Den här cmdleten returnerar inga utdata.

New-IseSnippet lagrar nya användarskapade kodfragment i osignerade .ps1xml filer. Windows PowerShell kan därför inte lägga till dem i en session där körningsprincipen är AllSigned eller Restricted. I en Begränsad eller AllSigned session kan du skapa, hämta och importera osignerade användarskapade kodfragment, men du kan inte använda dem i sessionen.

Om du använder cmdleten New-IseSnippet i en begränsad eller AllSigned session skapas kodfragmentet, men ett felmeddelande visas när Windows PowerShell försöker lägga till det nyligen skapade kodfragmentet i sessionen. Om du vill använda det nya kodfragmentet (och andra osignerade användarskapade kodfragment) ändrar du körningsprincipen och startar sedan om Windows PowerShell ISE.

Mer information om Körningsprinciper för Windows PowerShell finns i about_Execution_Policies.

• Om du vill ändra ett kodfragment redigerar du kodfragmentfilen. Du kan redigera kodfragmentfiler i fönstret Skript i Windows PowerShell ISE.
• Om du vill ta bort ett kodfragment som du har lagt till tar du bort kodfragmentfilen.
• Du kan inte ta bort ett inbyggt kodfragment, men du kan dölja alla inbyggda kodfragment med hjälp av kommandot "$psISE.Options.ShowDefaultSnippets=$false".
• Du kan skapa ett kodfragment som har samma namn som ett inbyggt kodfragment. Båda kodfragmenten visas i kodfragmentmenyn i Windows PowerShell ISE.