New-IseSnippet

  • Reference
Modul:
ISE

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

Syntax

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, vyberte v nabídce Upravit příkaz Spustit fragmenty kódu nebo stiskněte kombinaci kláves CTRL+J.

Rutina New-ISESnippet vytvoří <Title>.Snippets.ps1xml v $HOME\Documents\WindowsPowerShell\Snippets adresáři soubor 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é je zásada spouštění omezená nebo AllSigned, nelze použít uživatelem vytvořené fragmenty kódu.

Tato rutina byla zavedena ve Windows PowerShellu 3.0.

Příklady

Příklad 1: Vytvoření fragmentu nápovědy založené na komentářích

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

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é prostředí Windows PowerShell ISE. První příkaz uloží text fragmentu $M kódu do proměnné. Druhý příkaz pomocí rutiny New-ISESnippet vytvoří fragment kódu. Příkaz pomocí parametru Force přepíše předchozí fragment kódu 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 pomocí rutiny Copy-Item zkopíruje povinný fragment kódu ze složky, kam New-ISESnippet ho 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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:Int32
Position:Named
Default value:0
Required:False
Accept pipeline input:False
Accept wildcard characters: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ý.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters: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.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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ý.

Type:String
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Title

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

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters: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. Prostředí 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 vytvořit, získat a importovat nepodepsané fragmenty kódu vytvořené uživatelem, ale nemůžete je použít v relaci.

Pokud použijete rutinu New-IseSnippetv relaci Restricted nebo AllSigned , vytvoří se fragment kódu, ale při pokusu Windows PowerShellu o přidání nově vytvořeného fragmentu 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.