Freigeben über

New-IseSnippet

  • Referenz
Modul:
ISE

Erstellt einen Windows PowerShell ISE-Codeausschnitt.

Syntax

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

Beschreibung

Das New-ISESnippet-Cmdlet erstellt einen Codeausschnitt mit wiederverwendbarem Text für Windows PowerShell ISE. Sie können Codeausschnitte verwenden, um dem Skriptbereich oder dem Befehlsbereich in Windows PowerShell ISE Text hinzufügen. Dieses Cmdlet ist nur in Windows PowerShell ISE verfügbar.

Ab Windows PowerShell 3.0 enthält Windows PowerShell ISE eine Auflistung von integrierten Codeausschnitten. Mit dem New-ISESnippet-Cmdlet können Sie eigene Codeausschnitte erstellen, um sie der integrierten Auflistung hinzuzufügen. Sie können Codeausschnittsdateien anzeigen, ändern, hinzufügen, löschen und freigeben sowie in Windows PowerShell-Module einschließen. Um Codeausschnitte in Windows PowerShell ISE anzuzeigen, wählen Sie im Menü Bearbeiten die Option Startausschnitte aus, oder drücken Sie STRG+J.

Das Cmdlet New-ISESnippet erstellt einen <Titel>. Die Datei Snippets.ps1xml im Verzeichnis $home\Documents\WindowsPowerShell\Snippets mit dem von Ihnen angegebenen Titel. Um eine Codeausschnittsdatei in ein Modul einzuschließen, das Sie erstellen, fügen Sie die Codeausschnittsdatei einem Unterverzeichnis „Snippets“ Ihres Modulverzeichnisses hinzu.

Sie können nicht vom Benutzer erstellte Codeausschnitte in einer Sitzung verwenden, in der die Ausführungsrichtlinie Eingeschränkt oder AllSigned lautet.

Dieses Cmdlet wurde in Windows PowerShell 3.0 eingeführt.

Beispiele

Beispiel 1: Create eines Comment-BasedHelp-Ausschnitts

PS C:\> New-IseSnippet -Title Comment-BasedHelp -Description "A template for comment-based help." -Text "<#
    .SYNOPSIS
    .DESCRIPTION
    .PARAMETER  <Parameter-Name>
    .INPUTS
    .OUTPUTS
    .EXAMPLE
    .LINK
#>"

Dieser Befehl erstellt einen Comment-BasedHelp-Codeausschnitt für Windows PowerShell ISE. Er erstellt eine Datei namens „Comment-BasedHelp.snippets.ps1xml“ im Verzeichnis „Snippets“ des Benutzers ($home\Documents\WindowsPowerShell\Snippets).

Beispiel 2: Create eines obligatorischen Ausschnitts

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

In diesem Beispiel wird ein Obligatorischer Codeausschnitt für Windows PowerShell ISE erstellt. Der erste Befehl speichert den Codeausschnitttext in der variablen $M. Der zweite Befehl verwendet das New-ISESnippet-Cmdlet, um den Codeausschnitt zu erstellen. Der Befehl verwendet den Force-Parameter zum Überschreiben eines vorherigen Codeausschnitts mit dem gleichen Namen.

Beispiel 3: Kopieren eines obligatorischen Ausschnitts aus einem Ordner in einen Zielordner

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

Dieser Befehl verwendet das Cmdlet Copy-Item, um den Obligatorischen Codeausschnitt aus dem Ordner zu kopieren, in dem new-ISESnippet ihn in die Dateifreigabe Server\Freigabe platziert.

Da die von New-ISESnippet erstellten Dateien Snippets.ps1xml Textdateien (XML) sind, können Sie die Item-Cmdlets verwenden, um sie abzurufen, zu ändern, zu verschieben, umzubenennen und zu kopieren.

Parameter

-Author

Gibt den Autor des Codeausschnitts an. Das Autorfeld wird in der Codeausschnittsdatei angezeigt, aber es wird nicht eingeblendet, wenn Sie in Windows PowerShell ISE auf den Codeausschnittsnamen klicken.

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

-CaretOffset

Gibt das Zeichen des Codeausschnitttexts an, auf den dieses Cmdlet den Cursor platziert. Geben Sie eine ganze Zahl zur Darstellung der Cursorposition ein, wobei „1“ das erste Textzeichen darstellt. Der Standardwert 0 (null) platziert den Cursor unmittelbar vor dem ersten Textzeichen. Dieser Parameter rückt den Codeausschnittstext nicht ein.

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

-Description

Gibt eine Beschreibung des Codeausschnitts an. Der Beschreibungswert wird angezeigt, wenn Sie in Windows PowerShell ISE auf den Codeausschnittsnamen klicken. Dieser Parameter ist erforderlich.

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

-Force

Gibt an, dass dieses Cmdlet Codeausschnittdateien mit demselben Namen am selben Speicherort überschreibt. Standardmäßig überschreibt New-ISESnippet Dateien nicht.

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

-Text

Gibt den Textwert an, der hinzugefügt wird, wenn Sie den Codeausschnitt auswählen. Der Codeausschnittstext wird angezeigt, wenn Sie in Windows PowerShell ISE auf den Codeausschnittsnamen klicken. Dieser Parameter ist erforderlich.

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

-Title

Gibt einen Titel oder einen Namen für den Codeausschnitt an. Der Titel dient auch als Name der Codeausschnittsdatei. Dieser Parameter ist erforderlich.

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

Eingaben

None

Dieses Cmdlet nimmt keine Eingabe von der Pipeline an.

Ausgaben

None

Dieses Cmdlet generiert keine Ausgabe.

Hinweise

  • New-IseSnippet speichert neue vom Benutzer erstellte Codeausschnitte in nicht signierten PS1XML-Dateien. Daher kann Windows PowerShell sie nicht zu Sitzungen hinzufügen, in denen die Ausführungsrichtlinie AllSigned oder Restricted gilt. In einer Sitzung mit der Ausführungsrichtlinie Restricted oder AllSigned können Sie zwar unsignierte benutzererstellte Codeausschnitte erstellen, abrufen und importieren, aber nicht in der Sitzung verwenden.

Wenn Sie das Cmdlet New-IseSnippet in einer Restricted- oder AllSigned-Sitzung verwenden, wird der Codeausschnitt erstellt, aber eine Fehlermeldung wird angezeigt, wenn Windows PowerShell versucht, den neu erstellten Codeausschnitt der Sitzung hinzuzufügen. Um den neuen Codeausschnitt (und andere unsignierte benutzererstellte Codeausschnitte) zu verwenden, ändern Sie die Ausführungsrichtlinie, und starten Sie Windows PowerShell ISE neu.

Weitere Informationen zu Windows PowerShell-Ausführungsrichtlinien finden Sie unter about_Execution_Policies.

  • Um einen Codeausschnitt zu ändern, bearbeiten Sie die Codeausschnittdatei. Sie können Codeausschnittdateien im Skriptbereich von Windows PowerShell ISE bearbeiten.

  • Um einen hinzugefügten Codeausschnitt zu löschen, löschen Sie die Codeausschnittdatei.

  • Sie können einen integrierten Codeausschnitt nicht löschen, aber Sie können alle integrierten Codeausschnitte mit dem "$psise. Options.ShowDefaultSnippets=$false"-Befehl.

  • Sie können einen Codeausschnitt erstellen, der denselben Namen wie ein integrierter Codeausschnitt hat. Beide Codeausschnitte werden im Codeausschnittsmenü in Windows PowerShell ISE angezeigt.