Sdílet prostřednictvím

New-IseSnippet

  • Reference
Modul:
ISE

Vytvoří fragment kódu prostředí Windows PowerShell ISE.

Syntaxe

New-IseSnippet
   [-Title] <String>
   [-Description] <String>
   [-Text] <String>
   [-Author <String>]
   [-CaretOffset <Int32>]
   [-Force]
   [<CommonParameters>]

Description

Rutina New-ISESnippet vytvoří opakovaně použitelný text "fragment" 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 CTRL+J.

Rutina New-ISESnippet vytvoří soubor <Title>.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 nápovědy Comment-Based

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 fragmentů kódu uživatele $HOME\Documents\WindowsPowerShell\Snippets.

Příklad 2: Vytvoření povinného fragmentu kódu

$M = @'
Param
(
  [parameter(Mandatory=$true)]
  [String[]]
  $<ParameterName>
)
'@

New-ISESnippet -Text $M -Title Mandatory -Description "Adds a mandatory function parameter." -Author "Patti Fuller, Fabrikam Corp." -Force

Tento příklad vytvoří fragment kódu s názvem Povinné pro prostředí Windows PowerShell ISE. První příkaz uloží text fragmentu kódu do proměnné $M. Druhý příkaz použije rutinu New-ISESnippet k vytvoření fragmentu kódu. 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

Copy-Item "$HOME\Documents\WindowsPowerShell\Snippets\Mandatory.Snippets.ps1xml" -Destination "\\Server\Share"

Tento příkaz používá rutinu Copy-Item ke zkopírování povinného fragmentu ze složky, kde ji New-ISESnippet umístí do sdílené složky Server\Sdílená složka.

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.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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.

Typ:Int32
Position:Named
Default value:0
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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ý.

Typ:String
Position:2
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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.

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky: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ý.

Typ:String
Position:3
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Title

Určuje název nebo název fragmentu kódu. Název také pojmenuje soubor fragmentu kódu. Tento parametr je povinný.

Typ:String
Position:1
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

None

Do této rutiny nemůžete roušit objekty.

Výstupy

None

Tato rutina nevrátí žádný výstup.

Poznámky

New-IseSnippet ukládá nové fragmenty kódu vytvořené 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 zobrazí se chybová zpráva, když se Windows PowerShell pokusí přidat nově vytvořený fragment kódu do relace. 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.