Feedback

New-IseSnippet

  • Referentie
Module:
ISE

Hiermee maakt u een Windows PowerShell ISE-codefragment.

Syntax

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

Description

Met de New-ISESnippet cmdlet maakt u een herbruikbaar tekstfragment voor Windows PowerShell ISE. U kunt codefragmenten gebruiken om tekst toe te voegen aan het deelvenster Script of opdrachtvenster in Windows PowerShell ISE. Deze cmdlet is alleen beschikbaar in Windows PowerShell ISE.

Vanaf Windows PowerShell 3.0 bevat Windows PowerShell ISE een verzameling ingebouwde fragmenten. Met New-ISESnippet de cmdlet kunt u uw eigen fragmenten maken om toe te voegen aan de ingebouwde verzameling. U kunt fragmentbestanden weergeven, wijzigen, toevoegen, verwijderen en delen en opnemen in Windows PowerShell modules. Als u fragmenten in Windows PowerShell ISE wilt zien, selecteert u in het menu Bewerken de optie Fragmenten starten of drukt u op Ctrl+J.

De New-ISESnippet cmdlet maakt een <Title>.Snippets.ps1xml bestand in de $home\Documents\WindowsPowerShell\Snippets map met de titel die u opgeeft. Als u een fragmentbestand wilt opnemen in een module die u maakt, voegt u het fragmentbestand toe aan een submap fragmenten van de map van de module.

U kunt geen door de gebruiker gemaakte fragmenten gebruiken in een sessie waarin het uitvoeringsbeleid beperkt of AllSigned is.

Deze cmdlet is geïntroduceerd in Windows PowerShell 3.0.

Voorbeelden

Voorbeeld 1: Een Comment-Based Help-fragment maken

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

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

Met deze opdracht maakt u een Comment-BasedHelp fragment voor Windows PowerShell ISE. Er wordt een bestand gemaakt met de naam Comment-BasedHelp.snippets.ps1xml in de map $home\Documents\WindowsPowerShell\SnippetsFragmenten van de gebruiker.

Voorbeeld 2: Een verplicht fragment maken

$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

In dit voorbeeld wordt een codefragment gemaakt met de naam Verplicht voor Windows PowerShell ISE. Met de eerste opdracht wordt de fragmenttekst in de $M variabele opgeslagen. De tweede opdracht maakt gebruik van de New-ISESnippet cmdlet om het codefragment te maken. De opdracht gebruikt de parameter Force om een eerder fragment met dezelfde naam te overschrijven.

Voorbeeld 3: Een verplicht fragment kopiëren van een map naar een doelmap

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

Met deze opdracht wordt de Copy-Item cmdlet gebruikt om het verplichte fragment te kopiëren uit de map waarin New-ISESnippet het wordt geplaatst op de server-\sharebestandsshare.

Parameters

-Author

Hiermee geeft u de auteur van het fragment. Het auteursveld wordt weergegeven in het fragmentbestand, maar wordt niet weergegeven wanneer u op de naam van het fragment in Windows PowerShell ISE klikt.

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

Hiermee geeft u het teken op van de fragmenttekst waarop deze cmdlet de cursor plaatst. Voer een geheel getal in dat de cursorpositie vertegenwoordigt, met '1' die het eerste teken van tekst vertegenwoordigt. De standaardwaarde, 0 (nul), plaatst de cursor direct vóór het eerste teken van tekst. Met deze parameter wordt de fragmenttekst niet ingesprongen.

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

Hiermee geeft u een beschrijving van het fragment. De beschrijvingswaarde wordt weergegeven wanneer u op de naam van het fragment in Windows PowerShell ISE klikt. Deze parameter is vereist.

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Geeft aan dat met deze cmdlet fragmentbestanden met dezelfde naam op dezelfde locatie worden overschreven. New-ISESnippet Standaard worden bestanden niet overschreven.

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

Hiermee geeft u de tekstwaarde op die wordt toegevoegd wanneer u het fragment selecteert. De fragmenttekst wordt weergegeven wanneer u op de naam van het fragment in Windows PowerShell ISE klikt. Deze parameter is vereist.

Type:String
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Title

Hiermee geeft u een titel of naam voor het fragment op. De titel noemt ook het fragmentbestand. Deze parameter is vereist.

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

Invoerwaarden

None

Met deze cmdlet wordt geen invoer uit de pijplijn opgehaald.

Uitvoerwaarden

None

Met deze cmdlet wordt geen uitvoer gegenereerd.

Notities

New-IseSnippet slaat nieuwe door de gebruiker gemaakte fragmenten op in niet-ondertekende .ps1xml-bestanden. Als zodanig kan Windows PowerShell ze niet toevoegen aan een sessie waarin het uitvoeringsbeleid AllSigned of Restricted is. In een beperkte of allsigned-sessie kunt u niet-ondertekende door de gebruiker gemaakte fragmenten maken, ophalen en importeren, maar u kunt ze niet gebruiken in de sessie.

Als u de New-IseSnippet cmdlet gebruikt in een beperkte of AllSigned-sessie, wordt het fragment gemaakt, maar wordt er een foutbericht weergegeven wanneer Windows PowerShell probeert het zojuist gemaakte fragment toe te voegen aan de sessie. Als u het nieuwe fragment (en andere niet-ondertekende door de gebruiker gemaakte fragmenten) wilt gebruiken, wijzigt u het uitvoeringsbeleid en start u Windows PowerShell ISE opnieuw.

Zie about_Execution_Policies voor meer informatie over Windows PowerShell uitvoeringsbeleid.

  • Als u een fragment wilt wijzigen, bewerkt u het fragmentbestand. U kunt fragmentbestanden bewerken in het deelvenster Script van Windows PowerShell ISE.
  • Als u een fragment wilt verwijderen dat u hebt toegevoegd, verwijdert u het fragmentbestand.
  • U kunt een ingebouwd fragment niet verwijderen, maar u kunt alle ingebouwde fragmenten verbergen met behulp van de '$psise. Options.ShowDefaultSnippets=$false" opdracht.
  • U kunt een fragment met dezelfde naam maken als een ingebouwd fragment. Beide fragmenten worden weergegeven in het menu fragment in Windows PowerShell ISE.