Partager via

New-IseSnippet

  • Référence
Module:
ISE

Crée un extrait de code Windows PowerShell ISE.

Syntaxe

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

Description

L’applet New-ISESnippet de commande crée un texte réutilisable « extrait de code » 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 New-ISESnippet de commande 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 des extraits de code dans Windows PowerShell ISE, dans le menu Modifier, sélectionnez Démarrer des extraits de code ou appuyez sur Ctrl+J.

L’applet New-ISESnippet de commande crée un <Title>.Snippets.ps1xml fichier dans le $HOME\Documents\WindowsPowerShell\Snippets répertoire 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 des 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 : Créer un extrait d’aide basé sur des commentaires

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. Il crée un fichier nommé Comment-BasedHelp.snippets.ps1xml dans le répertoire $HOME\Documents\WindowsPowerShell\SnippetsExtraits de code de l’utilisateur.

Exemple 2 : Créer un extrait de code obligatoire

$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

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

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

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

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

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
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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
Valeur par défaut:0
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

None

Vous ne pouvez pas diriger les objets vers cette applet de commande.

Sorties

None

Cette applet de commande ne retourne pas de sortie.

Notes

New-IseSnippet stocke de nouveaux extraits de code créés par l’utilisateur dans des fichiers .ps1xml non signés. Par conséquent, Windows PowerShell ne peut pas les ajouter à une session dans laquelle la stratégie d’exécution est AllSigned ou Restricted. Dans une session Restreinte 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 New-IseSnippet de commande dans une session Restricted ou AllSigned , l’extrait de code est créé, mais un message d’erreur s’affiche lorsque 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 de 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 de la « $psise. Options.ShowDefaultSnippets=$false" commande.
  • 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.