Import-IseSnippet

Import-IseSnippet
    [-Path] <String>
    [-Recurse]
    [<CommonParameters>]

Import-IseSnippet
    -Module <String>
    [-Recurse]
    [-ListAvailable]
    [<CommonParameters>]

L’applet de commande Import-IseSnippet importe du texte réutilisable « extraits de code » à partir d’un module ou d’un répertoire dans la session active. Les extraits de code sont immédiatement disponibles pour une utilisation dans Windows PowerShell ISE. Cette applet de commande fonctionne uniquement dans l’environnement de script intégré Windows PowerShell (ISE).

Pour afficher et utiliser les extraits de code importés, dans le menu Modifier Windows PowerShell ISE, cliquez sur Démarrer les extraits de code ou appuyez sur Ctrl+J.

Les extraits de code importés sont disponibles uniquement dans la session active. Pour importer les extraits de code dans toutes les sessions WINDOWS PowerShell ISE, ajoutez une commande Import-IseSnippet à votre profil Windows PowerShell ou copiez les fichiers d’extraits de code dans votre répertoire d’extraits de code local $HOME\Documents\WindowsPowerShell\Snippets.

Pour importer des extraits de code, ils doivent être correctement mis en forme dans les extraits XML pour Windows PowerShell ISE et enregistrés dans les fichiers Snippet.ps1xml. Pour créer des extraits de code éligibles, utilisez l’applet de commande New-IseSnippet. New-IseSnippet crée un fichier <SnippetTitle>.Snippets.ps1xml dans le répertoire $HOME\Documents\WindowsPowerShell\Snippets. Vous pouvez déplacer ou copier les extraits dans le répertoire d’extraits de code d’un module Windows PowerShell ou vers n’importe quel autre répertoire.

L’applet de commande Get-IseSnippet, qui obtient les extraits de code créés par l’utilisateur dans le répertoire des extraits de code locaux, n’obtient pas d’extraits de code importés.

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

Cet exemple importe les extraits de code du répertoire \\Server01\Public\Snippets dans la session active. Il utilise le paramètre Recurse pour obtenir des extraits de code à partir de tous les sous-répertoires du répertoire Snippets.

Import-IseSnippet -Path \\Server01\Public\Snippets -Recurse

Cet exemple importe les extraits de code à partir du module SnippetModule. La commande utilise le paramètre ListAvailable pour importer les extraits de code même si le module SnippetModule n’est pas importé dans la session de l’utilisateur lors de l’exécution de la commande.

Import-IseSnippet -Module SnippetModule -ListAvailable

Cet exemple obtient des extraits de code dans tous les modules installés dans la variable d’environnement PSModulePath.

($Env:PSModulePath).Split(";") |
  ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} |
    ForEach-Object {$_.FullName}

Cet exemple importe tous les extraits de code de tous les modules installés dans la session active. En règle générale, vous n’avez pas besoin d’exécuter une commande comme celle-ci, car les modules qui ont des extraits de code utilisent l’applet de commande Import-IseSnippet pour les importer lorsque le module est importé.

($Env:PSModulePath).Split(";") |
  ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} |
    ForEach-Object {$psISE.CurrentPowerShellTab.Snippets.Load($_)}

Cet exemple copie les fichiers d’extraits de code de tous les modules installés dans le répertoire Snippets de l’utilisateur actuel. Contrairement aux extraits importés, qui affectent uniquement la session active, les extraits copiés sont disponibles dans chaque session Windows PowerShell ISE.

($Env:PSModulePath).Split(";") |
  ForEach-Object {dir $_\*\Snippets\*.Snippets.ps1xml -ErrorAction SilentlyContinue} |
    Copy-Item -Destination $HOME\Documents\WindowsPowerShell\Snippets

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.

• Vous ne pouvez pas utiliser l’applet de commande Get-IseSnippet pour obtenir des extraits de code importés. Get-IseSnippet obtient uniquement des extraits de code dans le répertoire $HOME\Documents\WindowsPowerShell\Snippets.

• Import-IseSnippet utilise la méthode statique Load des objets Microsoft.PowerShell.Host.ISE.ISESnippetCollection. Vous pouvez également utiliser la méthode Load d’extraits de code dans le modèle objet Windows PowerShell ISE : $psISE.CurrentPowerShellTab.Snippets.Load()

• L’applet de commande New-IseSnippet stocke les extraits de code créés par l’utilisateur dans des fichiers .ps1xml non signés. Par conséquent, Windows PowerShell ne peut pas les charger dans 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.

  Pour utiliser des extraits de code créés par l’utilisateur non signés que l’applet de commande Import-IseSnippet retourne, 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.