New-IseSnippet
Erstellt einen Windows PowerShell ISE-Codeausschnitt.
Syntax
Default (Standard)
New-IseSnippet
[-Title] <String>
[-Description] <String>
[-Text] <String>
[-Author <String>]
[-CaretOffset <Int32>]
[-Force]
[<CommonParameters>]
Beschreibung
Das cmdlet New-ISESnippet erstellt einen wiederverwendbaren Textausschnitt 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ü Bearbeiten aus, Codeausschnitte starten oder STRG+J drücken.
Mit dem Cmdlet New-ISESnippet wird ein <Title->erstellt. 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-BasedHelp Codeausschnitts
PS C:\> 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. Sie erstellt eine Datei namens "Comment-BasedHelp.snippets.ps1xml" im Codeausschnittverzeichnis des Benutzers ($home\Documents\WindowsPowerShell\Snippets).
Beispiel 2: Erstellen eines obligatorischen Codeausschnitts
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 $M Variablen. Der zweite Befehl verwendet das New-ISESnippet Cmdlet 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
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 sie in die Dateifreigabe "Server\Freigabe" platziert.
Da es sich bei den Codeausschnitten.ps1xml-Dateien New-ISESnippet um Textdateien (XML)-Dateien handelt, können Sie die Item--Cmdlets verwenden, um diese abzurufen, zu ändern, zu verschieben, umzubenennen und zu kopieren.
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.
Parametereigenschaften
| Typ: | String |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | 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.
Parametereigenschaften
| Typ: | Int32 |
| Standardwert: | 0 |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | 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.
Parametereigenschaften
| Typ: | String |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | 2 |
| Obligatorisch: | True |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-Force
Gibt an, dass dieses Cmdlet Codeausschnittdateien mit demselben Namen an demselben Speicherort überschreibt. Standardmäßig überschreibt New-ISESnippet- keine Dateien.
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | False |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | 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.
Parametereigenschaften
| Typ: | String |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | 3 |
| Obligatorisch: | True |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-Title
Gibt einen Titel oder Namen für den Codeausschnitt an. Der Titel benennt auch die Codeausschnittdatei. Dieser Parameter ist erforderlich.
Parametereigenschaften
| Typ: | String |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | 1 |
| Obligatorisch: | True |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
CommonParameters
Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.
Eingaben
None
Dieses Cmdlet verwendet keine Eingaben aus der Pipeline.
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 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 einem Restricted oder AllSigned Sitzung verwenden, wird der Codeausschnitt erstellt, aber eine Fehlermeldung wird angezeigt, wenn Windows PowerShell versucht, den neu erstellten Codeausschnitt zur 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.