Dela via

Import-IseSnippet

Modul:
ISE Module

Importerar ISE-kodfragment till den aktuella sessionen

Syntax

FromFolder (Standard) 

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

FromModule 

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

Description

Import-IseSnippet cmdlet importerar återanvändbar text "kodfragment" från en modul eller en katalog till den aktuella sessionen. Kodfragmenten är omedelbart tillgängliga för användning i Windows PowerShell ISE. Den här cmdleten fungerar endast i Windows PowerShell Integrated Scripting Environment (ISE).

Om du vill visa och använda de importerade kodfragmenten klickar du på Starta kodfragment från Menyn Windows PowerShell ISEEdit eller trycker på Ctrl + J.

Importerade kodfragment är endast tillgängliga i den aktuella sessionen. Om du vill importera kodfragmenten till alla Windows PowerShell ISE-sessioner lägger du till ett Import-IseSnippet-kommando i Din Windows PowerShell-profil eller kopierar kodfragmentfilerna till din lokala kodfragmentkatalog ($home\Documents\WindowsPowershell\Snippets).

Om du vill importera kodfragment måste de vara korrekt formaterade i kodfragmentets XML för Windows PowerShell ISE-kodfragment och sparas i Snippet.ps1xml-filer. Om du vill skapa berättigade kodfragment använder du cmdleten New-IseSnippet. New-IseSnippet skapar ett <SnippetTitle->. Filen Snippets.ps1xml i katalogen $home\Documents\WindowsPowerShell\Snippets. Du kan flytta eller kopiera kodfragmenten till katalogen Kodfragment i en Windows PowerShell-modul eller till någon annan katalog.

Cmdleten Get-IseSnippet, som hämtar användarskapade kodfragment i den lokala kodfragmentkatalogen, får inte importerade kodfragment.

Den här cmdleten introducerades i Windows PowerShell 3.0.

Exempel

Exempel 1: Importera kodfragment från en katalog

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

Det här kommandot importerar kodfragmenten från katalogen \\Server01\Public\Snippets till den aktuella sessionen. Den använder parametern Recurse för att hämta kodfragment från alla underkataloger i katalogen Kodfragment.

Exempel 2: Importera kodfragment från en modul

Import-IseSnippet -Module SnippetModule -ListAvailable

Det här kommandot importerar kodfragmenten från modulen SnippetModule. Kommandot använder parametern ListAvailable för att importera kodfragmenten även om modulen SnippetModule inte importeras till användarens session när kommandot körs.

Exempel 3: Hitta kodfragment i moduler

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

Det här kommandot hämtar kodfragment i alla installerade moduler i miljövariabeln PSModulePath.

Exempel 4: Importera alla modulfragment

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

Det här kommandot importerar alla kodfragment från alla installerade moduler till den aktuella sessionen. Vanligtvis behöver du inte köra ett kommando som det här eftersom moduler som har kodfragment använder Import-IseSnippet cmdlet för att importera dem åt dig när modulen importeras.

Exempel 5: Kopiera alla modulfragment

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

Det här kommandot kopierar kodfragmentfilerna från alla installerade moduler till katalogen Kodfragment för den aktuella användaren. Till skillnad från importerade kodfragment, som endast påverkar den aktuella sessionen, är kopierade kodfragment tillgängliga i varje Windows PowerShell ISE-session.

Parametrar

-ListAvailable

Anger att den här cmdleten hämtar kodfragment från moduler som är installerade på datorn, även om modulerna inte importeras till den aktuella sessionen. Om den här parametern utelämnas och modulen som anges av parametern Module inte importeras till den aktuella sessionen misslyckas försöket att hämta kodfragmenten från modulen.

Den här parametern är endast giltig när parametern Module används i kommandot .

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

FromModule
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Module

Importerar kodfragment från den angivna modulen till den aktuella sessionen. Jokertecken stöds inte.

Den här parametern importerar kodfragment från Snippet.ps1xml-filer i underkatalogen Kodfragment i modulsökvägen, till exempel $home\Documents\WindowsPowerShell\Modules\<ModuleName>\Snippets.

Den här parametern är utformad för att användas av modulförfattare i ett startskript, till exempel ett skript som anges i ScriptsToProcess nyckeln för ett modulmanifest. Kodfragment i en modul importeras inte automatiskt med modulen, men du kan använda kommandot Import-IseSnippet för att importera dem.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

FromModule
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Path

Anger sökvägen till kodfragmentkatalogen där den här cmdleten importerar kodfragment.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

FromFolder
Position:1
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Recurse

Ange att den här cmdleten importerar kodfragment från alla underkataloger för värdet för parametern Path.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

None

Den här cmdleten tar inte indata från pipelinen.

Utdata

None

Den här cmdleten genererar inte utdata.

Kommentarer

  • Du kan inte använda cmdleten Get-IseSnippet för att hämta importerade kodfragment. Get-IseSnippet bara hämtar kodfragment i katalogen $home\Documents\WindowsPowerShell\Snippets.

  • Import-IseSnippet använder Load static-metoden för objekten Microsoft.PowerShell.Host.ISE.ISESnippetCollection. Du kan också använda metoden Load för kodfragment i Windows PowerShell ISE-objektmodellen: $psISE.CurrentPowerShellTab.Snippets.Load()

  • Cmdleten New-IseSnippet lagrar nya användarskapade kodfragment i osignerade .ps1xml-filer. Därför kan Windows PowerShell inte läsa in dem i en session där körningsprincipen är AllSigned eller Restricted. I en Begränsad eller AllSigned session kan du skapa, hämta och importera osignerade användarskapade kodfragment, men du kan inte använda dem i sessionen.

    Om du vill använda osignerade användarskapade kodfragment som Import-IseSnippet cmdlet returnerar ändrar du körningsprincipen och startar sedan om Windows PowerShell ISE.

    Mer information om Körningsprinciper för Windows PowerShell finns i about_Execution_Policies.