New-IseSnippet

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

L’applet de commande New-ISESnippet 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 Script ou au volet Commande 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 des 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 les extraits de code ou appuyez sur Ctrl+J.

L’applet de commande New-ISESnippet crée un fichier <Title>.Snippets.ps1xml dans le répertoire $HOME\Documents\WindowsPowerShell\Snippets avec le titre que vous spécifiez. Pour inclure un fichier d’extrait de code dans un module que vous créez, ajoutez le fichier d’extraits de code à un sous-répertoire Extraits de code 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.

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 Extraits de code de l’utilisateur $HOME\Documents\WindowsPowerShell\Snippets.

$M = @'
param
(
  [Parameter(Mandatory=$true)]
  [string[]]
  $<ParameterName>
)
'@

$snippet = @{
    Text = $M
    Title = 'Mandatory'
    Description = 'Adds a mandatory function parameter.'
    Author = 'Patti Fuller, Fabrikam Corp.'
    Force = $true
}
New-ISESnippet @snippet

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 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 portant le même nom.

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

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

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

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

Cette applet de commande ne retourne aucune sortie.

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 restreint . Dans un restreint ou session 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 un Restricted ou session 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 commande « $psISE.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 extrait de code dans Windows PowerShell ISE.