New-IseSnippet

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

Polecenie cmdlet New-ISESnippet tworzy tekst wielokrotnego użytku "fragment kodu" dla środowiska Windows PowerShell ISE. Możesz użyć fragmentów kodu, aby dodać tekst do okienka Skrypt lub okienka Polecenia w środowisku Windows PowerShell ISE. To polecenie cmdlet jest dostępne tylko w środowisku Windows PowerShell ISE.

Począwszy od programu Windows PowerShell 3.0, środowisko Windows PowerShell ISE zawiera kolekcję wbudowanych fragmentów kodu. Polecenie cmdlet New-ISESnippet umożliwia utworzenie własnych fragmentów kodu w celu dodania ich do wbudowanej kolekcji. Pliki fragmentów kodu można wyświetlać, zmieniać, dodawać, usuwać i udostępniać oraz dołączać je do modułów programu Windows PowerShell. Aby wyświetlić fragmenty kodu w środowisku Windows PowerShell ISE, z menu Edytuj wybierz pozycję Start Fragmenty kodu lub naciśnij CTRL+J.

Polecenie cmdlet New-ISESnippet tworzy plik <Title>.Snippets.ps1xml w katalogu $HOME\Documents\WindowsPowerShell\Snippets z określonym tytułem. Aby dołączyć plik fragmentu kodu do tworzonego modułu, dodaj plik fragmentu kodu do podkatalogu fragmentów kodu w katalogu modułu.

Nie można używać fragmentów kodu utworzonych przez użytkownika w sesji, w której zasady wykonywania są z ograniczeniami lub AllSigned.

To cmdlet zostało wprowadzone w Windows PowerShell 3.0.

New-IseSnippet -Title Comment-BasedHelp -Description "A template for comment-based help." -Text "<#
    .SYNOPSIS

    .DESCRIPTION
    .PARAMETER  <Parameter-Name>
    .INPUTS
    .OUTPUTS
    .EXAMPLE
    .LINK
#>"

To polecenie tworzy fragment kodu Comment-BasedHelp dla środowiska Windows PowerShell ISE. Tworzy plik o nazwie Comment-BasedHelp.snippets.ps1xml w katalogu fragmentów kodu użytkownika $HOME\Documents\WindowsPowerShell\Snippets.

$M = @'
param
(
  [Parameter(Mandatory=$true)]
  [string[]]
  $<ParameterName>
)
'@

$snippet = @{
    Text = $M
    Title = 'Mandatory'
    Description = 'Adds a mandatory function parameter.'
    Author = 'Patti Fuller, Fabrikam Corp.'
    Force = $true
}
New-ISESnippet @snippet

W tym przykładzie tworzony jest fragment kodu o nazwie Obowiązkowe dla środowiska Windows PowerShell ISE. Pierwsze polecenie zapisuje tekst fragmentu kodu w zmiennej $M. Drugie polecenie używa polecenia cmdlet New-ISESnippet do utworzenia fragmentu kodu. Polecenie używa parametru Force, aby zastąpić poprzedni fragment kodu o tej samej nazwie.

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

To polecenie używa polecenia cmdlet Copy-Item do skopiowania obowiązkowego fragmentu kodu z folderu, w którym New-ISESnippet umieszcza go w udziale plików Server\Share.

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Nie można przekazywać obiektów do tego cmdletu.

To polecenie cmdlet nie zwraca żadnych danych wyjściowych.

New-IseSnippet przechowuje nowe fragmenty kodu utworzone przez użytkownika w niepodpisanych plikach .ps1xml. W związku z tym program Windows PowerShell nie może dodać ich do sesji, w której zasady wykonywania są AllSigned lub z ograniczeniami. W sesji z ograniczeniami lub AllSigned można tworzyć, pobierać i importować niepodpisane fragmenty kodu utworzone przez użytkownika, ale nie można ich używać w sesji.

Jeśli używasz polecenia cmdlet New-IseSnippet w z ograniczeniami lub sesji AllSigned, zostanie utworzony fragment kodu, ale podczas próby dodania nowo utworzonego fragmentu kodu do sesji zostanie wyświetlony komunikat o błędzie. Aby użyć nowego fragmentu kodu (i innych niepodpisanych fragmentów kodu utworzonych przez użytkownika), zmień zasady wykonywania, a następnie uruchom ponownie środowisko Windows PowerShell ISE.

Aby uzyskać więcej informacji na temat zasad wykonywania programu Windows PowerShell, zobacz about_Execution_Policies.

• Aby zmienić fragment kodu, edytuj plik fragmentu kodu. Pliki fragmentu kodu można edytować w okienku Skrypt środowiska Windows PowerShell ISE.
• Aby usunąć dodany fragment kodu, usuń plik fragmentu kodu.
• Nie można usunąć wbudowanego fragmentu kodu, ale można ukryć wszystkie wbudowane fragmenty kodu przy użyciu polecenia "$psISE.Options.ShowDefaultSnippets=$false".
• Możesz utworzyć fragment kodu o takiej samej nazwie jak wbudowany fragment kodu. Oba fragmenty kodu są wyświetlane w menu fragmentów kodu w środowisku Windows PowerShell ISE.