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 Cmdlet New-ISESnippet erstellt einen wiederverwendbaren Text "Codeausschnitt" für Windows PowerShell ISE. Sie können Codeausschnitte verwenden, um Text zum Skriptbereich oder Befehlsbereich in Windows PowerShell ISE hinzuzufügen. Dieses Cmdlet ist nur in Windows PowerShell ISE verfügbar.

Ab Windows PowerShell 3.0 enthält Windows PowerShell ISE eine Sammlung integrierter Codeausschnitte. Mit dem Cmdlet New-ISESnippet können Sie eigene Codeausschnitte erstellen, die der integrierten Auflistung hinzugefügt werden sollen. Sie können Codeausschnittdateien anzeigen, ändern, hinzufügen, löschen und freigeben und in Windows PowerShell-Module einschließen. Um Codeausschnitte in Windows PowerShell ISE anzuzeigen, wählen Sie im Menü BearbeitenCodeausschnitte aus, oder drücken Sie STRG+J.

Das Cmdlet New-ISESnippet erstellt eine <Title>.Snippets.ps1xml Datei im verzeichnis $HOME\Documents\WindowsPowerShell\Snippets mit dem von Ihnen angegebenen Titel. Um eine Codeausschnittdatei in ein Modul einzuschließen, das Sie erstellen, fügen Sie die Codeausschnittdatei einem Codeausschnitt-Unterverzeichnis Ihres Modulverzeichnisses hinzu.

Sie können keine vom Benutzer erstellten Codeausschnitte in einer Sitzung verwenden, in der die Ausführungsrichtlinie Restricted oder AllSignedist.

Dieses Cmdlet wurde in Windows PowerShell 3.0 eingeführt.

Beispiele

Beispiel 1: Erstellen eines Comment-Based Hilfeausschnitts

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

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

Mit diesem Befehl wird ein Comment-BasedHelp Codeausschnitt für Windows PowerShell ISE erstellt. Es erstellt eine Datei mit dem Namen Comment-BasedHelp.snippets.ps1xml im Codeausschnittverzeichnis des Benutzers $HOME\Documents\WindowsPowerShell\Snippets.

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 mit dem Namen Obligatorischen für Windows PowerShell ISE erstellt. Der erste Befehl speichert den Codeausschnitttext in der variablen $M. Der zweite Befehl verwendet das cmdlet New-ISESnippet zum Erstellen des Codeausschnitts. Der Befehl verwendet den Force-Parameter, 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 Cmdlet Copy-Item, um den Obligatorischen Codeausschnitt aus dem Ordner zu kopieren, in dem New-ISESnippet ihn in die Dateifreigabe "Server\Freigabe" platziert.

Parameter

-Author

Gibt den Autor des Codeausschnitts an. Das Feld "Autor" wird in der Codeausschnittdatei angezeigt, wird aber nicht angezeigt, wenn Sie in Windows PowerShell ISE auf den Codeausschnittnamen klicken.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-CaretOffset

Gibt das Zeichen des Codeausschnitttexts an, auf den dieses Cmdlet den Cursor platziert. Geben Sie eine ganze Zahl ein, die die Cursorposition darstellt, wobei "1" das erste Zeichen des Texts darstellt. Der Standardwert 0 (Null) platziert den Cursor unmittelbar vor dem ersten Textzeichen. Mit diesem Parameter wird der Codeausschnitttext nicht eingezogen.

Typ:Int32
Position:Named
Standardwert:0
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Description

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

Typ:String
Position:2
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Force

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

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Text

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

Typ:String
Position:3
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Title

Gibt einen Titel oder Namen für den Codeausschnitt an. Der Titel benennt auch die Codeausschnittdatei. Dieser Parameter ist erforderlich.

Typ:String
Position:1
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren: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 Restrictedist. In einer Restricted oder AllSigned-Sitzung können Sie nicht signierte, vom Benutzer erstellte 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. Wenn Sie den neuen Codeausschnitt (und andere nicht signierte, vom Benutzer erstellte Codeausschnitte) verwenden möchten, ändern Sie die Ausführungsrichtlinie, und starten Sie windows PowerShell ISE dann 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 Codeausschnittmenü in Windows PowerShell ISE angezeigt.