Import-IseSnippet
ISE-kódrészletek importálása az aktuális munkamenetbe
Syntax
FromFolder (Alapértelmezett)
Import-IseSnippet
[-Path] <String>
[-Recurse]
[<CommonParameters>]
FromModule
Import-IseSnippet
-Module <String>
[-Recurse]
[-ListAvailable]
[<CommonParameters>]
Description
Az Import-IseSnippet parancsmag újrahasználható szövegrészeket importál egy modulból vagy könyvtárból az aktuális munkamenetbe. A kódrészletek azonnal elérhetők a Windows PowerShell ISE-ben való használatra. Ez a parancsmag csak a Windows PowerShell integrált szkriptelési környezetében (ISE) működik.
Az importált kódrészletek megtekintéséhez és használatához a Windows PowerShell ISEEdit menüjében kattintson a Kódrészletek indítása parancsra, vagy nyomja le a Ctrl + J billentyűkombinációt.
Az importált kódrészletek csak az aktuális munkamenetben érhetők el. Ha az összes Windows PowerShell ISE-munkamenetbe szeretné importálni a kódrészleteket, adjon hozzá egy Import-IseSnippet parancsot a Windows PowerShell-profiljához, vagy másolja a kódrészletfájlokat a helyi kódrészletek könyvtárába ($home\Documents\WindowsPowershell\Snippets).
A kódrészletek importálásához megfelelően kell formázni őket a Windows PowerShell ISE-kódtöredékekhez készült kódrészlet XML-fájljában, és snippet.ps1xml fájlokba kell menteni őket. Jogosult kódrészletek létrehozásához használja a New-IseSnippet parancsmagot. New-IseSnippet létrehoz egy <kódrészletetTitle>. Snippets.ps1xml fájl a $home\Documents\WindowsPowerShell\Snippets könyvtárban. A kódrészleteket áthelyezheti vagy átmásolhatja egy Windows PowerShell-modul Kódrészletek könyvtárába vagy bármely más könyvtárba.
A Get-IseSnippet parancsmag, amely a helyi kódrészletek könyvtárában kapja meg a felhasználó által létrehozott kódrészleteket, nem kap importált kódrészleteket.
Ezt a parancsmagot a Windows PowerShell 3.0-ban vezettük be.
Példák
1. példa: Kódrészletek importálása könyvtárból
Import-IseSnippet -Path \\Server01\Public\Snippets -Recurse
Ez a parancs importálja a kódrészleteket a \\Server01\Public\Snippets könyvtárból az aktuális munkamenetbe. A Recurse paramétert használja a Kódrészletek könyvtár összes alkönyvtárának kódrészleteinek lekéréséhez.
2. példa: Kódrészletek importálása modulból
Import-IseSnippet -Module SnippetModule -ListAvailable
Ez a parancs importálja a kódrészleteket a KódrészletModule modulból. A parancs a ListAvailable paramétert használja a kódrészletek importálásához akkor is, ha a kódrészletModule modul nem lesz importálva a felhasználó munkamenetébe a parancs futtatásakor.
3. példa: Kódrészletek keresése modulokban
($env:PSModulePath).split(";") | ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} | ForEach-Object {$_.fullname}
Ez a parancs a PSModulePath környezeti változó összes telepített moduljában lekéri a kódrészleteket.
4. példa: Az összes modulrészlet importálása
($env:PSModulePath).split(";") | ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} | ForEach-Object {$psise.CurrentPowerShellTab.Snippets.Load($_)}
Ez a parancs importálja az összes kódrészletet az összes telepített modulból az aktuális munkamenetbe. Általában nem kell ilyen parancsot futtatnia, mert a kódrészletekkel rendelkező modulok a Import-IseSnippet parancsmaggal importálják őket a modul importálásakor.
5. példa: Az összes modulrészlet másolása
($env:PSModulePath).split(";") | ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} | Copy-Item -Destination $home\Documents\WindowsPowerShell\Snippets
Ez a parancs az összes telepített modul kódrészletfájljait az aktuális felhasználó Kódrészletek könyvtárába másolja. Az importált kódrészletekkel ellentétben, amelyek csak az aktuális munkamenetet érintik, a másolt kódrészletek minden Windows PowerShell ISE-munkamenetben elérhetők.
Paraméterek
-ListAvailable
Azt jelzi, hogy ez a parancsmag kódrészleteket kap a számítógépre telepített modulokból, még akkor is, ha a modulok nem importálódnak az aktuális munkamenetbe. Ha ez a paraméter nincs megadva, és a modul paraméter által megadott modul nincs importálva az aktuális munkamenetbe, a kódrészletek modulból való lekérésének kísérlete sikertelen lesz.
Ez a paraméter csak akkor érvényes, ha a Modul paramétert használja a parancs.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
FromModule
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Module
Kódrészleteket importál a megadott modulból az aktuális munkamenetbe. A helyettesítő karakterek nem támogatottak.
Ez a paraméter a modul elérési útjának Kódrészletek alkönyvtárában lévő Snippet.ps1xml-fájlokból importál kódrészleteket, például $home\Documents\WindowsPowerShell\Modules\<ModuleName>\Snippets.
Ezt a paramétert úgy tervezték, hogy a modul szerzői egy indítási szkriptben használják, például egy moduljegyzék ScriptsToProcess kulcsában megadott szkriptet. A modulban lévő kódrészletek nem lesznek automatikusan importálva a modullal, de importálásukhoz használhat egy Import-IseSnippet parancsot.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
FromModule
| Position: | Named |
| Kötelező: | True |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Path
Megadja annak a kódrészlet-könyvtárnak az elérési útját, amelyben ez a parancsmag importálja a kódrészleteket.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
FromFolder
| Position: | 1 |
| Kötelező: | True |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Recurse
Jelezze, hogy ez a parancsmag a Elérési út paraméter értékének minden alkönyvtárából importál kódrészleteket.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
CommonParameters
Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.
Bevitelek
None
Ez a parancsmag nem fogad bemenetet a folyamatból.
Kimenetek
None
Ez a parancsmag nem hoz létre kimenetet.
Jegyzetek
Nem használhatja a Get-IseSnippet parancsmagot az importált kódrészletek lekéréséhez. Get-IseSnippet csak a $home\Documents\WindowsPowerShell\Snippets könyvtárban lévő kódrészleteket kapja meg.
Import-IseSnippet a Microsoft.PowerShell.Host.ISE.ISESnippetCollection objektumok Load statikus metódusát használja. A Kódrészletek betöltése metódust a Windows PowerShell ISE objektummodellben is használhatja: $psISE.CurrentPowerShellTab.Snippets.Load()
A New-IseSnippet parancsmag az új, felhasználó által létrehozott kódrészleteket nem aláírt .ps1xml fájlokban tárolja. Ezért a Windows PowerShell nem tudja betölteni őket olyan munkamenetbe, amelyben a végrehajtási szabályzat AllSigned vagy Korlátozott. Korlátozott vagy AllSigned munkamenetben létrehozhat, lekérhet és importálhat nem aláírt, felhasználó által létrehozott kódrészleteket, de a munkamenetben nem használhatja őket.
Ha nem aláírt, felhasználó által létrehozott kódrészleteket szeretne használni, amelyeket a Import-IseSnippet parancsmag visszaad, módosítsa a végrehajtási szabályzatot, majd indítsa újra a Windows PowerShell ISE-t.
További információ a Windows PowerShell végrehajtási szabályzatairól: about_Execution_Policies.