New-IseSnippet

  • Referens
Modul:
ISE

Skapar ett Windows PowerShell ISE-kodfragment.

Syntax

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

Description

Cmdleten New-ISESnippet skapar en återanvändbar 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 redigera-menyn och väljer Starta kodfragment eller trycker på CTRL+J.

Cmdleten New-ISESnippet skapar en <rubrik>. Filen Snippets.ps1xml 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.

Denna cmdlet introducerades i Windows PowerShell 3.0.

Exempel

Exempel 1: Skapa ett Comment-BasedHelp kodfragment

PS C:\> 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).

Exempel 2: Skapa ett obligatoriskt kodfragment

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

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

I det här exemplet skapas ett obligatoriskt kodfragment 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 force-parametern för att skriva över ett tidigare kodfragment med samma namn.

Exempel 3: Kopiera ett obligatoriskt kodfragment från en mapp till en målmapp

PS C:\> Copy-Item "$Home\Documents\WindowsPowerShell\Snippets\Mandatory.Snippets.ps1xml" -Destination "\\Server\Share"

Det här kommandot använder cmdleten Copy-Item för att kopiera det obligatoriska kodfragmentet från mappen där New-ISESnippet placerar det på server\dela-filresursen.

Eftersom filerna Snippets.ps1xml som New-ISESnippet skapar är textfiler (XML), kan du använda cmdletarna Item för att hämta, ändra, flytta, byta namn och kopiera dem.

Parametrar

-Author

Anger författaren till kodfragmentet. Fältet författare visas i kodfragmentfilen, men det visas inte när du klickar på kodfragmentets namn i Windows PowerShell ISE.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CaretOffset

Anger tecknet för kodfragmenttexten som den här cmdleten placerar markören på. Ange ett heltal som representerar markörens position med "1" som representerar det första tecknet i texten. Standardvärdet 0 (noll) placerar markören omedelbart före det första tecknet i texten. Den här parametern drar inte in kodfragmenttexten.

Type:Int32
Position:Named
Default value:0
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Anger en beskrivning av kodfragmentet. Beskrivningsvärdet visas när du klickar på kodfragmentets namn i Windows PowerShell ISE. Den här parametern krävs.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Force

Anger att den här cmdleten skriver över kodfragmentfiler med samma namn på samma plats. New-ISESnippet skriver inte över filer som standard.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Text

Anger det textvärde som läggs till när du väljer kodfragmentet. Kodfragmenttexten visas när du klickar på kodfragmentets namn i Windows PowerShell ISE. Den här parametern krävs.

Type:String
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Title

Anger en rubrik eller ett namn för kodfragmentet. Rubriken namnger även kodfragmentfilen. Den här parametern krävs.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Indata

None

Den här cmdleten tar inte indata från pipelinen.

Utdata

None

Den här cmdleten genererar inga utdata.

Kommentarer

  • New-IseSnippet lagrar nya användarskapade kodfragment i osignerade .ps1xml-filer. Därför kan Windows PowerShell inte lägga till dem i en session där körningsprincipen är AllSigned eller Restricted. I en begränsad session 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 session 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 Windows PowerShell körningsprinciper finns i about_Execution_Policies.

  • Om du vill ändra ett kodfragment redigerar du kodfragmentfilen. Du kan redigera kodfragmentfiler i skriptfönstret i Windows PowerShell ISE.

  • Ta bort ett kodfragment som du har lagt till genom att ta bort kodfragmentfilen.

  • Du kan inte ta bort ett inbyggt kodfragment, men du kan dölja alla inbyggda kodfragment med hjälp av "$psise. Options.ShowDefaultSnippets=$false"-kommandot.

  • Du kan skapa ett kodfragment som har samma namn som ett inbyggt kodfragment. Båda kodfragmenten visas på kodfragmentmenyn i Windows PowerShell ISE.