Megosztás a következőn keresztül:

New-IseSnippet

Modul:
ISE Module

Létrehoz egy Windows PowerShell ISE kódrészletet.

Syntax

Default (Alapértelmezett) 

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

Description

A New-ISESnippet parancsmag egy újrafelhasználható szövegrészletet hoz létre a Windows PowerShell ISE-hez. Kódrészletekkel szöveget adhat hozzá a Windows PowerShell ISE Szkript vagy Parancs paneljéhez. Ez a parancsmag csak a Windows PowerShell ISE-ben érhető el.

A Windows PowerShell 3.0-tól kezdve a Windows PowerShell ISE beépített kódrészleteket tartalmaz. A New-ISESnippet parancsmaggal saját kódrészleteket hozhat létre, amelyek hozzáadhatók a beépített gyűjteményhez. Megtekintheti, módosíthatja, hozzáadhatja, törölheti és megoszthatja a kódrészletfájlokat, és belefoglalhatja őket a Windows PowerShell-modulokba. A Windows PowerShell ISE kódrészleteinek megtekintéséhez a Szerkesztés menüben válassza a Kódrészletek indítása vagy a CTRL+J billentyűkombinációt.

Az New-ISESnippet parancsmag létrehoz egy <Cím>. Snippets.ps1xml fájl a $home\Documents\WindowsPowerShell\Snippets könyvtárban a megadott címmel. Ha egy kódrészletfájlt szeretne belefoglalni egy olyan modulba, amelyet éppen készít, adja hozzá a kódrészletfájlt a modulkönyvtár kódrészletek alkönyvtárához.

Nem használhat felhasználó által létrehozott kódrészleteket olyan munkamenetben, amelyben a végrehajtási szabályzat Korlátozott vagy AllSigned.

Ezt a parancsmagot a Windows PowerShell 3.0-ban vezettük be.

Példák

1. példa: Comment-BasedHelp kódrészlet létrehozása

PS C:\> New-IseSnippet -Title Comment-BasedHelp -Description "A template for comment-based help." -Text "<#
    .SYNOPSIS
    .DESCRIPTION
    .PARAMETER  <Parameter-Name>
    .INPUTS
    .OUTPUTS
    .EXAMPLE
    .LINK
#>"

Ez a parancs létrehoz egy Comment-BasedHelp kódrészletet a Windows PowerShell ISE-hez. Létrehoz egy "Comment-BasedHelp.snippets.ps1xml" nevű fájlt a felhasználó Kódrészletek könyvtárában ($home\Documents\WindowsPowerShell\Snippets).

2. példa: Kötelező kódrészlet létrehozása

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

Ez a példa létrehoz egy kötelező kódrészletet a Windows PowerShell ISE-hez. Az első parancs menti a kódrészlet szövegét a $M változóba. A második parancs a New-ISESnippet parancsmagot használja a kódrészlet létrehozásához. A parancs a Force paramétert használja egy korábbi, azonos nevű kódrészlet felülírásához.

3. példa: Kötelező kódrészlet másolása egy mappából egy célmappába

PS C:\> Copy-Item "$Home\Documents\WindowsPowerShell\Snippets\Mandatory.Snippets.ps1xml" -Destination "\\Server\Share"

Ez a parancs a Copy-Item parancsmaggal másolja a Kötelező kódrészletet abból a mappából, ahol New-ISESnippet a Kiszolgáló\Megosztás fájlmegosztásba helyezi.

Mivel a New-ISESnippet Snippets.ps1xml fájlok szöveges (XML) fájlok, az Elem parancsmagokkal lekérheti, módosíthatja, áthelyezheti, átnevezheti és másolhatja őket.

Paraméterek

-Author

Megadja a kódrészlet szerzőjét. A szerzői mező megjelenik a kódrészletfájlban, de nem jelenik meg, amikor a Kódrészlet nevére kattint a Windows PowerShell ISE-ben.

Paramétertulajdonságok

Típus:String
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-CaretOffset

Megadja annak a kódrészletnek a karakterét, amelyen a parancsmag elhelyezi a kurzort. Adjon meg egy egész számot, amely a kurzor pozícióját jelöli, és az "1" a szöveg első karakterét jelöli. Az alapértelmezett 0 (nulla) érték közvetlenül a szöveg első karaktere elé helyezi a kurzort. Ez a paraméter nem írja be a kódrészlet szövegét.

Paramétertulajdonságok

Típus:Int32
Alapértelmezett érték:0
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-Description

Megadja a kódrészlet leírását. A leírás értéke akkor jelenik meg, ha a kódrészlet nevére kattint a Windows PowerShell ISE-ben. Ez a paraméter kötelező.

Paramétertulajdonságok

Típus:String
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:2
Kötelező:True
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-Force

Azt jelzi, hogy ez a parancsmag felülírja az azonos nevű kódrészletfájlokat ugyanazon a helyen. Alapértelmezés szerint New-ISESnippet nem írja felül a fájlokat.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:Named
Kötelező:False
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-Text

Megadja a kódrészlet kiválasztásakor hozzáadott szöveges értéket. A kódrészlet szövege akkor jelenik meg, ha a kódrészlet nevére kattint a Windows PowerShell ISE-ben. Ez a paraméter kötelező.

Paramétertulajdonságok

Típus:String
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:3
Kötelező:True
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

-Title

Megadja a kódrészlet címét vagy nevét. A cím a kódrészletfájlnak is nevet ad. Ez a paraméter kötelező.

Paramétertulajdonságok

Típus:String
Alapértelmezett érték:None
Támogatja a helyettesítő karaktereket:False
DontShow:False

Paraméterkészletek

(All)
Position:1
Kötelező:True
Folyamatból származó érték:False
Folyamatból származó érték tulajdonságnév alapján:False
Fennmaradó argumentumokból származó érték:False

CommonParameters

Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.

Bevitelek

None

Ez a parancsmag nem fogad bemenetet a folyamatból.

Kimenetek

None

Ez a parancsmag nem hoz létre kimenetet.

Jegyzetek

  • New-IseSnippet az új, felhasználó által létrehozott kódrészleteket nem aláírt .ps1xml fájlokban tárolja. Ezért a Windows PowerShell nem tudja hozzáadni őket olyan munkamenethez, amelyben a végrehajtási szabályzat AllSigned vagy Korlátozott. Korlátozott vagy AllSigned munkamenetben létrehozhat, lekérhet és importálhat nem aláírt, felhasználó által létrehozott kódrészleteket, de a munkamenetben nem használhatja őket.

Ha a New-IseSnippet parancsmagot Korlátozott vagy AllSigned munkamenetben használja, a kódrészlet létrejön, de hibaüzenet jelenik meg, amikor a Windows PowerShell megpróbálja hozzáadni az újonnan létrehozott kódrészletet a munkamenethez. Az új kódrészlet (és más, nem aláírt, felhasználó által létrehozott kódrészletek) használatához módosítsa a végrehajtási szabályzatot, majd indítsa újra a Windows PowerShell ISE-t.

További információ a Windows PowerShell végrehajtási szabályzatairól: about_Execution_Policies.

  • Kódrészlet módosításához szerkessze a kódrészletfájlt. A kódrészletfájlokat a Windows PowerShell ISE Szkript paneljén szerkesztheti.

  • A hozzáadott kódrészlet törléséhez törölje a kódrészletfájlt.

  • Beépített kódrészletet nem törölhet, de az összes beépített kódrészletet elrejtheti a "$psise. Options.ShowDefaultSnippets=$false" parancs.

  • Létrehozhat egy olyan kódrészletet, amelynek neve megegyezik a beépített kódrészlet nevével. Mindkét kódrészlet megjelenik a Windows PowerShell ISE kódrészlet menüjében.