Import-IseSnippet
Importiert ISE-Codeausschnitte in die aktuelle Sitzung
Syntax
FromFolder (Standard)
Import-IseSnippet
[-Path] <String>
[-Recurse]
[<CommonParameters>]
FromModule
Import-IseSnippet
-Module <String>
[-Recurse]
[-ListAvailable]
[<CommonParameters>]
Beschreibung
Das Cmdlet Import-IseSnippet importiert wiederverwendbare Textausschnitte aus einem Modul oder einem Verzeichnis in die aktuelle Sitzung. Die Codeausschnitte stehen sofort zur Verwendung in Windows PowerShell ISE zur Verfügung. Dieses Cmdlet funktioniert nur in windows PowerShell Integrated Scripting Environment (ISE).
Um die importierten Codeausschnitte anzuzeigen und zu verwenden, klicken Sie im Windows PowerShell ISEEdit-Menü auf Codeausschnitte starten, oder drücken Sie STRG+J.
Importierte Codeausschnitte sind nur in der aktuellen Sitzung verfügbar. Um die Codeausschnitte in alle Windows PowerShell ISE-Sitzungen zu importieren, fügen Sie Ihrem Windows PowerShell-Profil den Befehl Import-IseSnippet hinzu, oder kopieren Sie die Codeausschnittdateien in Ihr lokales Codeausschnittverzeichnis ($home\Dokumente\WindowsPowershell\Snippets).
Zum Importieren von Codeausschnitten müssen sie im Codeausschnitt-XML für Windows PowerShell ISE-Codeausschnitte ordnungsgemäß formatiert und in Codeausschnitten.ps1xml-Dateien gespeichert werden. Um geeignete Codeausschnitte zu erstellen, verwenden Sie das Cmdlet New-IseSnippet. New-IseSnippet erstellt einen <SnippetTitle>. Snippets.ps1xml im Verzeichnis $home\Documents\WindowsPowerShell\Snippets. Sie können die Codeausschnitte in das Codeausschnittverzeichnis eines Windows PowerShell-Moduls oder in ein anderes Verzeichnis verschieben oder kopieren.
Das Cmdlet Get-IseSnippet, das vom Benutzer erstellte Codeausschnitte im lokalen Codeausschnittverzeichnis abruft, ruft keine importierten Codeausschnitte ab.
Dieses Cmdlet wurde in Windows PowerShell 3.0 eingeführt.
Beispiele
Beispiel 1: Importieren von Codeausschnitten aus einem Verzeichnis
Import-IseSnippet -Path \\Server01\Public\Snippets -Recurse
Mit diesem Befehl werden die Codeausschnitte aus dem Verzeichnis \\Server01\Public\Snippets in die aktuelle Sitzung importiert. Er verwendet den Parameter Recurse, um Snippets aus allen Unterverzeichnissen des Snippets-Verzeichnisses abzurufen.
Beispiel 2: Importieren von Codeausschnitten aus einem Modul
Import-IseSnippet -Module SnippetModule -ListAvailable
Mit diesem Befehl werden die Codeausschnitte aus dem SnippetModule-Modul importiert. Der Befehl verwendet den ListAvailable-Parameter , um die Codeausschnitte auch dann zu importieren, wenn das SnippetModule-Modul nicht in die Sitzung des Benutzers importiert wird, wenn der Befehl ausgeführt wird.
Beispiel 3: Suchen von Codeausschnitten in Modulen
($env:PSModulePath).split(";") | ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} | ForEach-Object {$_.fullname}
Mit diesem Befehl werden Ausschnitte in allen installierten Modulen in der Umgebungsvariablen PSModulePath abgerufen.
Beispiel 4: Importieren aller Modulausschnitte
($env:PSModulePath).split(";") | ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} | ForEach-Object {$psise.CurrentPowerShellTab.Snippets.Load($_)}
Dieser Befehl importiert alle Snippets aus allen installierten Modulen in die aktuelle Sitzung. In der Regel müssen Sie einen solchen Befehl nicht ausführen, da Module mit Codeausschnitten das Cmdlet Import-IseSnippet verwenden, um sie für Sie zu importieren, wenn das Modul importiert wird.
Beispiel 5: Kopieren aller Modulausschnitte
($env:PSModulePath).split(";") | ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} | Copy-Item -Destination $home\Documents\WindowsPowerShell\Snippets
Mit diesem Befehl werden die Snippet-Dateien aller installierten Module in das Snippets-Verzeichnis des aktuellen Benutzers kopiert. Im Gegensatz zu importierten Codeausschnitten, die sich nur auf die aktuelle Sitzung auswirken, sind kopierte Codeausschnitte in jeder Windows PowerShell ISE-Sitzung verfügbar.
Parameter
-ListAvailable
Gibt an, dass dieses Cmdlet Codeausschnitte aus Modulen abruft, die auf dem Computer installiert sind, auch wenn die Module nicht in die aktuelle Sitzung importiert werden. Wenn dieser Parameter weggelassen wird und das Modul, das durch den Parameter Module angegeben wird, nicht in die aktuelle Sitzung importiert wird, schlägt der Versuch, die Codeausschnitte aus dem Modul abzurufen, fehl.
Dieser Parameter ist nur gültig, wenn der parameter Module im Befehl verwendet wird.
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
FromModule
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-Module
Importiert Codeausschnitte aus dem angegebenen Modul in die aktuelle Sitzung. Platzhalterzeichen werden nicht unterstützt.
Dieser Parameter importiert Codeausschnitte aus Snippet.ps1xml-Dateien im Unterverzeichnis Snippets im Modulpfad, z. B. $home\Documents\WindowsPowerShell\Modules\<ModuleName>\Snippets.
Dieser Parameter wurde entwickelt, um von Modulautoren in einem Startskript verwendet zu werden, z. B. ein skript, das im ScriptsToProcess Schlüssel eines Modulmanifests angegeben ist. Snippets in einem Modul werden nicht automatisch mit dem Modul importiert, aber Sie können den Befehl Import-IseSnippet verwenden, um sie zu importieren.
Parametereigenschaften
| Typ: | String |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
FromModule
| Position: | Named |
| Obligatorisch: | True |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-Path
Gibt den Pfad zum Codeausschnittverzeichnis an, in dem dieses Cmdlet Codeausschnitte importiert.
Parametereigenschaften
| Typ: | String |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
FromFolder
| Position: | 1 |
| Obligatorisch: | True |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-Recurse
Geben Sie an, dass dieses Cmdlet Codeausschnitte aus allen Unterverzeichnissen des Werts des Path-Parameters importiert.
Parametereigenschaften
| Typ: | SwitchParameter |
| 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 |
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
Sie können das Cmdlet Get-IseSnippet nicht verwenden, um importierte Codeausschnitte abzurufen. Get-IseSnippet ruft nur Codeausschnitte im Verzeichnis $home\Documents\WindowsPowerShell\Snippets ab.
Import-IseSnippet verwendet die statische Load-Methode von Microsoft.PowerShell.Host.ISE.ISESnippetCollection-Objekten. Sie können auch die Load-Methode von Codeausschnitten im Windows PowerShell ISE-Objektmodell verwenden: $psISE.CurrentPowerShellTab.Snippets.Load()
Das Cmdlet New-IseSnippet speichert neue, vom Benutzer erstellte Codeausschnitte in nicht signierten PS1xml-Dateien. Daher kann Windows PowerShell sie nicht in eine Sitzung laden, 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 nicht signierte, vom Benutzer erstellte Codeausschnitte verwenden möchten, die vom Cmdlet Import-IseSnippet zurückgegeben werden, ändern Sie die Ausführungsrichtlinie, und starten Sie dann Windows PowerShell ISE neu.
Weitere Informationen zu Windows PowerShell-Ausführungsrichtlinien finden Sie unter about_Execution_Policies.