New-IseSnippet
Vytvoří fragment kódu prostředí Windows PowerShell ISE.
Syntax
Default (Výchozí)
New-IseSnippet
[-Title] <String>
[-Description] <String>
[-Text] <String>
[-Author <String>]
[-CaretOffset <Int32>]
[-Force]
[<CommonParameters>]
Description
Rutina New-ISESnippet vytvoří opakovaně použitelný text fragmentu pro prostředí Windows PowerShell ISE. Fragmenty kódu můžete použít k přidání textu do podokna Skript nebo podokno příkazů v prostředí Windows PowerShell ISE. Tato rutina je dostupná jenom v prostředí Windows PowerShell ISE.
Počínaje Windows PowerShellem 3.0 obsahuje integrované fragmenty kódu integrované skriptování (ISE) Windows PowerShellu. Rutina New-ISESnippet umožňuje vytvořit vlastní fragmenty kódu pro přidání do integrované kolekce. Můžete zobrazit, změnit, přidat, odstranit a sdílet soubory fragmentů kódu a zahrnout je do modulů Windows PowerShellu. Pokud chcete zobrazit fragmenty kódu v prostředí Windows PowerShell ISE, v nabídce Upravit vyberte spustit fragmenty kódu nebo stiskněte kombinaci kláves CTRL+J.
Rutina New-ISESnippet vytvoří<název >. Soubor Snippets.ps1xml v adresáři $home\Documents\WindowsPowerShell\Snippets s názvem, který zadáte. Pokud chcete do modulu, který vytváříte, zahrnout soubor fragmentu kódu, přidejte soubor fragmentu do podadresáře fragmentů adresáře modulu.
V relaci, ve které jsou zásady spouštění Omezené nebo AllSignednelze použít fragmenty kódu vytvořené uživatelem.
Tato rutina byla zavedena ve Windows PowerShellu 3.0.
Příklady
Příklad 1: Vytvoření fragmentu Comment-BasedHelp
PS C:\> New-IseSnippet -Title Comment-BasedHelp -Description "A template for comment-based help." -Text "<#
.SYNOPSIS
.DESCRIPTION
.PARAMETER <Parameter-Name>
.INPUTS
.OUTPUTS
.EXAMPLE
.LINK
#>"
Tento příkaz vytvoří fragment kódu Comment-BasedHelp pro prostředí Windows PowerShell ISE. Vytvoří soubor s názvem Comment-BasedHelp.snippets.ps1xml v adresáři Fragments uživatele ($home\Documents\WindowsPowerShell\Snippets).
Příklad 2: Vytvoření povinného fragmentu kódu
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
Tento příklad vytvoří povinný fragment kódu pro prostředí Windows PowerShell ISE. První příkaz uloží text fragmentu kódu do proměnné $M. Druhý příkaz k vytvoření fragmentu kódu používá rutinu New-ISESnippet. Příkaz používá parametr Force k přepsání předchozího fragmentu se stejným názvem.
Příklad 3: Zkopírování povinného fragmentu ze složky do cílové složky
PS C:\> Copy-Item "$Home\Documents\WindowsPowerShell\Snippets\Mandatory.Snippets.ps1xml" -Destination "\\Server\Share"
Tento příkaz pomocí rutiny Copy-Item zkopíruje povinný fragment kódu ze složky, do které New-ISESnippet umístí do sdílené složky Server\Sdílená složka.
Protože soubory Snippets.ps1xml, které New-ISESnippet vytváří, jsou textové soubory (XML), můžete pomocí rutin Item získat, změnit, přesunout, přejmenovat a zkopírovat.
Parametry
-Author
Určuje autora fragmentu kódu. Pole autora se zobrazí v souboru fragmentu kódu, ale nezobrazí se, když kliknete na název fragmentu kódu v prostředí Windows PowerShell ISE.
Vlastnosti parametru
| Typ: | String |
| 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 |
-CaretOffset
Určuje znak textu fragmentu kódu, na který tato rutina umístí kurzor. Zadejte celé číslo, které představuje pozici kurzoru, přičemž 1 představuje první znak textu. Výchozí hodnota 0 (nula) umístí kurzor bezprostředně před první znak textu. Tento parametr neodsadí text fragmentu kódu.
Vlastnosti parametru
| Typ: | Int32 |
| Default value: | 0 |
| 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 |
-Description
Určuje popis fragmentu kódu. Hodnota popisu se zobrazí po kliknutí na název fragmentu kódu v prostředí Windows PowerShell ISE. Tento parametr je povinný.
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | 2 |
| Povinné: | True |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Force
Označuje, že tato rutina přepíše soubory fragmentu kódu se stejným názvem ve stejném umístění. Ve výchozím nastavení New-ISESnippet nepřepíše soubory.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| 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 |
-Text
Určuje textová hodnota, která se přidá při výběru fragmentu kódu. Text fragmentu kódu se zobrazí po kliknutí na název fragmentu kódu v prostředí Windows PowerShell ISE. Tento parametr je povinný.
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | 3 |
| Povinné: | True |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Title
Určuje název nebo název fragmentu kódu. Název také pojmenuje soubor fragmentu kódu. Tento parametr je povinný.
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| 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 |
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 žádný výstup.
Poznámky
- New-IseSnippet ukládá nové fragmenty kódu vytvořeného uživatelem do nepodepsaných souborů .ps1xml. Windows PowerShell je proto nemůže přidat 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 použijete rutinu New-IseSnippet v Restricted nebo AllSigned relaci, vytvoří se fragment kódu, ale při pokusu Windows PowerShellu o přidání nově vytvořeného fragmentu kódu do relace se zobrazí chybová zpráva. Pokud chcete použít nový fragment kódu (a další nepodepsané fragmenty kódu vytvořené uživatelem), změňte zásady spouštění a restartujte integrované skripty (ISE) Windows PowerShellu.
Další informace o zásadách spouštění prostředí Windows PowerShell najdete v tématu about_Execution_Policies.
Pokud chcete změnit fragment kódu, upravte soubor fragmentu kódu. Soubory fragmentu kódu můžete upravovat v podokně Skript prostředí Windows PowerShell ISE.
Pokud chcete odstranit přidaný fragment kódu, odstraňte soubor fragmentu kódu.
Předdefinovaný fragment kódu nelze odstranit, ale všechny předdefinované fragmenty kódu můžete skrýt pomocí $psise. Options.ShowDefaultSnippets=$false" příkaz.
Můžete vytvořit fragment kódu, který má stejný název jako předdefinovaný fragment kódu. Oba fragmenty kódu se zobrazí v nabídce fragmentu kódu v prostředí Windows PowerShell ISE.