Sdílet prostřednictvím

Import-IseSnippet

Modul:
ISE Module

Importuje fragmenty ise do aktuální relace.

Syntax

FromFolder (Výchozí) 

Import-IseSnippet
    [-Path] <String>
    [-Recurse]
    [<CommonParameters>]

FromModule 

Import-IseSnippet
    -Module <String>
    [-Recurse]
    [-ListAvailable]
    [<CommonParameters>]

Description

Rutina Import-IseSnippet importuje opakovaně použitelné fragmenty textu z modulu nebo adresáře do aktuální relace. Fragmenty kódu jsou okamžitě dostupné pro použití v prostředí Windows PowerShell ISE. Tato rutina funguje jenom v integrovaném skriptovacím prostředí Windows PowerShellu (ISE).

Importované fragmenty kódu zobrazíte a použijete tak, že v nabídce IsEEdit windows PowerShellu kliknete na Start Snippets nebo stisknete Kombinaci kláves Ctrl+J.

Importované fragmenty kódu jsou k dispozici pouze v aktuální relaci. Pokud chcete importovat fragmenty kódu do všech relací prostředí Windows PowerShell ISE, přidejte do profilu Windows PowerShellu příkaz Import-IseSnippet nebo zkopírujte soubory fragmentů kódu do místního adresáře fragmentů kódu ($home\Documents\WindowsPowershell\Snippets).

Aby bylo možné importovat fragmenty kódu, musí být správně naformátované ve formátu XML fragmentu kódu pro fragmenty ise windows PowerShellu a uloženy v souborech Snippet.ps1xml. K vytvoření oprávněných fragmentů kódu použijte rutinu New-IseSnippet. New-IseSnippet vytvoří<>SnippetTitle . Soubor Snippets.ps1xml v adresáři $home\Documents\WindowsPowerShell\Snippets. Fragmenty kódu můžete přesunout nebo zkopírovat do adresáře Fragmenty kódu modulu Windows PowerShellu nebo do jakéhokoli jiného adresáře.

Rutina Get-IseSnippet, která získá fragmenty kódu vytvořené uživatelem v adresáři místních fragmentů kódu, nezískal importované fragmenty kódu.

Tato rutina byla zavedena ve Windows PowerShellu 3.0.

Příklady

Příklad 1: Import fragmentů kódu z adresáře

Import-IseSnippet -Path \\Server01\Public\Snippets -Recurse

Tento příkaz naimportuje fragmenty kódu z adresáře \\Server01\Public\Snippets do aktuální relace. Používá parametr Recurse k získání fragmentů ze všech podadresářů adresáře Fragments.

Příklad 2: Import fragmentů kódu z modulu

Import-IseSnippet -Module SnippetModule -ListAvailable

Tento příkaz naimportuje fragmenty kódu z modulu SnippetModule. Příkaz používá parametr ListAvailable k importu fragmentů kódu, i když se modul SnippetModule při spuštění příkazu neimportuje do relace uživatele.

Příklad 3: Vyhledání fragmentů v modulech

($env:PSModulePath).split(";") | ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} | ForEach-Object {$_.fullname}

Tento příkaz získá fragmenty kódu ve všech nainstalovaných modulech v proměnné prostředí PSModulePath.

Příklad 4: Import všech fragmentů kódu modulu

($env:PSModulePath).split(";") | ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} | ForEach-Object {$psise.CurrentPowerShellTab.Snippets.Load($_)}

Tento příkaz importuje všechny fragmenty kódu ze všech nainstalovaných modulů do aktuální relace. Obvykle nemusíte spouštět podobný příkaz, protože moduly s fragmenty kódu budou používat rutinu Import-IseSnippet k jejich importu za vás při importu modulu.

Příklad 5: Kopírování všech fragmentů kódu modulu

($env:PSModulePath).split(";") | ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} | Copy-Item -Destination $home\Documents\WindowsPowerShell\Snippets

Tento příkaz zkopíruje soubory fragmentů ze všech nainstalovaných modulů do adresáře Fragments aktuálního uživatele. Na rozdíl od importovaných fragmentů kódu, které ovlivňují pouze aktuální relaci, jsou zkopírované fragmenty kódu dostupné v každé relaci prostředí Windows PowerShell ISE.

Parametry

-ListAvailable

Označuje, že tato rutina získá fragmenty z modulů nainstalovaných v počítači, i když moduly nejsou importovány do aktuální relace. Pokud tento parametr vynecháte a modul zadaný parametrem Module se do aktuální relace nenaimportuje, pokus o získání fragmentů z modulu selže.

Tento parametr je platný pouze v případě, že se v příkazu použije parametr modulu.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

FromModule
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Module

Importuje fragmenty kódu ze zadaného modulu do aktuální relace. Zástupné znaky nejsou podporovány.

Tento parametr naimportuje fragmenty kódu ze souborů Snippet.ps1xml v podadresáři Fragmenty v cestě modulu, například $home\Documents\WindowsPowerShell\Modules\<ModuleName>\Snippets.

Tento parametr je navržený tak, aby ho autoři modulů používali ve spouštěcím skriptu, například skript zadaný v ScriptsToProcess klíč manifestu modulu. Fragmenty kódu v modulu se neimportují automaticky s modulem, ale k jejich importu můžete použít příkaz Import-IseSnipp et.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

FromModule
Position:Named
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Path

Určuje cestu k adresáři fragmentů kódu, ve kterém tato rutina importuje fragmenty kódu.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

FromFolder
Position:1
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Recurse

Označuje, že tato rutina importuje fragmenty kódu ze všech podadresářů hodnoty Path parametru.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

None

Tato rutina nepřebírají vstup z kanálu.

Výstupy

None

Tato rutina negeneruje výstup.

Poznámky

  • K získání importovaných fragmentů kódu nemůžete použít rutinu Get-IseSnippet. Get-IseSnippet získá pouze fragmenty kódu v adresáři $home\Documents\WindowsPowerShell\Snippets.

  • Import-IseSnippet používá statickou metodu Load objekty Microsoft.PowerShell.Host.ISE.ISESnippetCollection. Můžete také použít metodu Load fragmentů kódu v objektovém modelu prostředí Windows PowerShell ISE: $psISE.CurrentPowerShellTab.Snippets.Load()

  • Rutina New-IseSnippet ukládá nové fragmenty kódu vytvořeného uživatelem do nepodepsaných souborů .ps1xml. Prostředí Windows PowerShell je proto nemůže načíst do relace, ve které jsou zásady spouštění allSigned nebo Restricted. V relaci Restricted nebo AllSigned můžete vytvářet, získávat a importovat nepodepsané fragmenty kódu vytvořeného uživatelem, ale nemůžete je použít v relaci.

    Pokud chcete použít nepodepsané uživatelem vytvořené fragmenty kódu, které vrací rutina Import-IseSnippet, změňte zásady spouštění a restartujte prostředí Windows PowerShell ISE.

    Další informace o zásadách spouštění prostředí Windows PowerShell najdete v tématu about_Execution_Policies.