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 wiederverwendbaren Text "Codeausschnitt" 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, die der integrierten Auflistung hinzugefügt werden sollen. 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 "Codeausschnitte starten" aus, oder drücken Sie STRG+J.

Das New-ISESnippet Cmdlet erstellt eine <Title>.Snippets.ps1xml Datei im $HOME\Documents\WindowsPowerShell\Snippets Verzeichnis 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 keine vom Benutzer erstellten Codeausschnitte in einer Sitzung verwenden, in der die Ausführungsrichtlinie "Restricted" oder "AllSigned" lautet.

Dieses Cmdlet wurde in Windows PowerShell 3.0 eingeführt.

Beispiele

Beispiel 1: Erstellen eines kommentarbasierten Hilfeausschnitts

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. Es erstellt eine Datei mit dem Namen Comment-BasedHelp.snippets.ps1xml im Codeausschnittverzeichnis $HOME\Documents\WindowsPowerShell\Snippetsdes Benutzers.

Beispiel 2: Erstellen eines obligatorischen Codeausschnitts

$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 diesem Beispiel wird ein Codeausschnitt namens "Obligatorisch" für Windows PowerShell ISE erstellt. Der erste Befehl speichert den Codeausschnitttext in der $M Variablen. Der zweite Befehl verwendet das New-ISESnippet Cmdlet zum Erstellen des Codeausschnitts. Der Befehl verwendet den Parameter Force , um einen vorherigen Codeausschnitt mit demselben Namen zu überschreiben.

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

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

Dieser Befehl verwendet das Copy-Item Cmdlet, um den obligatorischen Codeausschnitt aus dem Ordner zu kopieren, in dem New-ISESnippet er in die Dateifreigabe "Server\Freigabe" abgelegt wird.

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 an demselben Speicherort überschreibt. Dateien werden standardmäßig New-ISESnippet nicht überschrieben.

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

Sie können keine Objekte an dieses Cmdlet weiterleiten.

Ausgaben

None

Dieses Cmdlet gibt keine Ausgabe zurück.

Hinweise

New-IseSnippet speichert neue vom Benutzer erstellte Codeausschnitte in nicht signierten PS1XML-Dateien. Daher kann Windows PowerShell sie nicht zu einer Sitzung hinzufügen, in der die Ausführungsrichtlinie "AllSigned" oder "Restricted" lautet. In einer Eingeschränkten oder AllSigned-Sitzung können Sie nicht signierte, vom Benutzer erstellte Codeausschnitte erstellen, abrufen und importieren, sie können jedoch nicht in der Sitzung verwenden.

Wenn Sie das New-IseSnippet Cmdlet in einer Eingeschränkten oder AllSigned-Sitzung verwenden, wird der Codeausschnitt erstellt, es wird jedoch eine Fehlermeldung 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 von Ihnen hinzugefügten Codeausschnitt zu löschen, löschen Sie die Codeausschnittdatei.
  • Sie können keinen integrierten Codeausschnitt löschen, aber Sie können alle integrierten Codeausschnitte mithilfe der "$psise" ausblenden. 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.