Partager via

New-IseSnippet

  • Référence
Module:
ISE

Crée un extrait de code Windows PowerShell ISE.

Syntax

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

Description

L'applet de commande New-ISESnippet crée un « extrait de code » de texte réutilisable pour Windows PowerShell ISE. Vous pouvez utiliser des extraits de code pour ajouter du texte au volet de script ou de commandes dans Windows PowerShell ISE. Cette applet de commande est disponible uniquement dans Windows PowerShell ISE.

À compter de Windows PowerShell 3.0, Windows PowerShell ISE inclut une collection d'extraits de code intégrés. L'applet de commande New-ISESnippet vous permet de créer vos propres extraits de code à ajouter à la collection intégrée. Vous pouvez afficher, modifier, ajouter, supprimer et partager les fichiers d'extraits de code et les inclure dans les modules Windows PowerShell. Pour afficher les extraits de code dans Windows PowerShell ISE, dans le menu Modifier, sélectionnez Démarrer les extraits de code ou appuyez sur Ctrl+J.

L’applet de commande New-ISESnippet crée un <titre>. Fichier Snippets.ps1xml dans le répertoire $home\Documents\WindowsPowerShell\Snippets avec le titre que vous spécifiez. Pour inclure un fichier d'extraits de code dans un module que vous créez, ajoutez le fichier d'extraits à un sous-répertoire Snippets de votre répertoire de module.

Vous ne pouvez pas utiliser d’extraits de code créés par l’utilisateur dans une session dans laquelle la stratégie d’exécution est Restreinte ou AllSigned.

Cette applet de commande a été introduite dans Windows PowerShell 3.0.

Exemples

Exemple 1 : Create un extrait de code Comment-BasedHelp

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

Cette commande crée un extrait de code Comment-BasedHelp pour Windows PowerShell ISE. Elle crée un fichier nommé Comment-BasedHelp.snippets.ps1xml dans le répertoire Snippets de l'utilisateur ($home\Documents\WindowsPowerShell\Snippets).

Exemple 2 : Create un extrait de code obligatoire

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

Cet exemple crée un extrait de code obligatoire pour Windows PowerShell ISE. La première commande enregistre le texte de l’extrait de code dans la variable $M. La deuxième commande utilise l'applet de commande New-ISESnippet pour créer l'extrait de code. La commande utilise le paramètre Force pour remplacer un extrait de code précédent avec le même nom.

Exemple 3 : Copier un extrait de code obligatoire d’un dossier vers un dossier de destination

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

Cette commande utilise l’applet de commande Copy-Item pour copier l’extrait de code obligatoire à partir du dossier où New-ISESnippet le place dans le partage de fichiers Server\Share.

Étant donné que les fichiers Snippets.ps1xml créés par New-ISESnippet sont des fichiers de texte (XML), vous pouvez utiliser les applets de commande Item pour les obtenir, les modifier, les déplacer, les renommer et les copier.

Paramètres

-Author

Spécifie l’auteur de l’extrait de code. Le champ de l'auteur apparaît dans le fichier d'extraits de code, mais il n'apparaît pas quand vous cliquez sur le nom de l'extrait de code dans Windows PowerShell ISE.

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

-CaretOffset

Spécifie le caractère du texte de l’extrait de code sur lequel cette applet de commande place le curseur. Entrez un entier qui représente la position du curseur, « 1 » représentant le premier caractère de texte. La valeur par défaut, 0 (zéro), place le curseur immédiatement avant le premier caractère de texte. Ce paramètre ne met pas en retrait le texte de l'extrait de code.

Type:Int32
Position:Named
Default value:0
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Spécifie une description de l’extrait de code. La valeur de description s'affiche quand vous cliquez sur le nom de l'extrait de code dans Windows PowerShell ISE. Ce paramètre est obligatoire.

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

-Force

Indique que cette applet de commande remplace les fichiers d’extraits de code portant le même nom dans le même emplacement. Par défaut, New-ISESnippet ne remplace pas les fichiers.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Text

Spécifie la valeur de texte qui est ajoutée quand vous sélectionnez l'extrait de code. Le texte de l'extrait apparaît quand vous cliquez sur le nom de l'extrait de code dans Windows PowerShell ISE. Ce paramètre est obligatoire.

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

-Title

Spécifie un titre ou un nom pour l'extrait de code. Le titre nomme également le fichier d'extraits de code. Ce paramètre est obligatoire.

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

Entrées

None

Cette applet de commande n'accepte pas d'entrée provenant du pipeline.

Sorties

None

Cette applet de commande ne génère aucune sortie.

Notes

  • New-IseSnippet stocke les nouveaux extraits de code créés par l’utilisateur dans des fichiers .ps1xml non signés. En conséquence, Windows PowerShell ne peut pas les ajouter à une session dans laquelle la stratégie d'exécution est AllSigned ou Restricted. Dans une session Restricted ou AllSigned, vous pouvez créer, obtenir et importer des extraits de code créés par l'utilisateur non signés, mais vous ne pouvez pas les utiliser dans la session.

Si vous utilisez l’applet de commande New-IseSnippet dans une session Restricted ou AllSigned, l’extrait de code est créé, mais un message d’erreur s’affiche quand Windows PowerShell tente d’ajouter l’extrait de code nouvellement créé à la session. Pour utiliser le nouvel extrait de code (et d'autres extraits créés par l'utilisateur non signés), modifiez la stratégie d'exécution, puis redémarrez Windows PowerShell ISE.

Pour plus d'informations sur les stratégies d'exécution Windows PowerShell, consultez about_Execution_Policies.

  • Pour modifier un extrait de code, modifiez le fichier d’extrait de code. Vous pouvez modifier des fichiers d’extraits de code dans le volet Script de Windows PowerShell ISE.

  • Pour supprimer un extrait de code que vous avez ajouté, supprimez le fichier d’extrait de code.

  • Vous ne pouvez pas supprimer un extrait de code intégré, mais vous pouvez masquer tous les extraits de code intégrés à l’aide du « $psise. Commande Options.ShowDefaultSnippets=$false ».

  • Vous pouvez créer un extrait de code portant le même nom qu’un extrait de code intégré. Les deux extraits de code apparaissent dans le menu des extraits de Windows PowerShell ISE.