New-IseSnippet

  • Referencia
Modul:
ISE

Létrehoz egy Windows PowerShell I Standard kiadás kódrészletet.

Syntax

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

Description

A New-ISESnippet parancsmag létrehoz egy újrafelhasználható szövegrészletet a Windows PowerShell I Standard kiadás számára. Kódrészletek használatával szöveget adhat hozzá a Windows PowerShell I Szkript vagy Parancs paneljéhez Standard kiadás. Ez a parancsmag csak a Windows PowerShell I Standard kiadás-ban érhető el.

A Windows PowerShell 3.0-tól kezdve a Windows PowerShell I Standard kiadás 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 I Standard kiadás kódrészleteinek megtekintéséhez a Szerkesztés menüben válassza a Kódrészletek indítása lehetőséget, vagy nyomja le a CTRL J billentyűkombinációt+.

A New-ISESnippet parancsmag létrehoz egy <Title>.Snippets.ps1xml fájlt 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: Megjegyzésalapú súgórészlet létrehozása

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 I Standard kiadás számára. Létrehoz egy fájlt Comment-BasedHelp.snippets.ps1xml 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

$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

Ez a példa létrehoz egy Kötelező nevű kódrészletet a Windows PowerShell I-hez Standard kiadás. Az első parancs menti a kódrészlet szövegét a $M változóban. A második parancs a New-ISESnippet parancsmaggal hozza létre a kódrészletet. A parancs a Force paraméterrel felülír egy korábbi kódrészletet ugyanazzal a névvel.

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

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, amely New-ISESnippet a Kiszolgáló\Megosztás fájlmegosztásba helyezi.

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 I Standard kiadás.

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

Type:Int32
Position:Named
Default value:0
Required:False
Accept pipeline input:False
Accept wildcard characters: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 I Standard kiadás. Ez a paraméter kötelező.

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

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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, amikor a kódrészlet nevére kattint a Windows PowerShell I Standard kiadás. Ez a paraméter kötelező.

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

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

Bevitelek

None

Ehhez a parancsmaghoz nem lehet objektumokat csövezni.

Kimenetek

None

Ez a parancsmag nem ad vissza 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 munkamenetekben létrehozhat, lekérhet és importálhat nem hozzárendelt, felhasználó által létrehozott kódrészleteket, de a munkamenetben nem használhatja őket.

Ha korlátozott vagy AllSigned munkamenetben használja a New-IseSnippet parancsmagot, 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 I Standard kiadás.

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 I szkriptablakában szerkesztheti Standard kiadás.
  • 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 I kódrészlet menüjében Standard kiadás.