Partager via

Import-IseSnippet

  • Référence
Module:
ISE

Importe les extraits de code de l'environnement ISE dans la session active.

Syntaxe

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

Description

L’applet Import-IseSnippet de commande 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 Édition de Windows PowerShell ISE, cliquez sur Démarrer des extraits de code ou appuyez sur Ctrl+J.

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

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 New-IseSnippet commande. New-IseSnippet crée un <SnippetTitle>.Snippets.ps1xml fichier dans le $HOME\Documents\WindowsPowerShell\Snippets répertoire. Vous pouvez déplacer ou copier les extraits de code dans le répertoire Snippets d'un module Windows PowerShell ou dans tout autre répertoire.

L’applet Get-IseSnippet de commande, 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 importés.

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

Exemples

Exemple 1 : Importer des extraits de code à partir d’un répertoire

Cet exemple importe les extraits de code \\Server01\Public\Snippets du répertoire 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 Extraits de code.

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

Exemple 2 : Importer des extraits de code à partir d’un module

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

Exemple 3 : Rechercher des extraits de code dans des modules

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}

Exemple 4 : Importer tous les extraits de code de module

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 Import-IseSnippet de commande 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($_)}

Exemple 5 : Copier tous les extraits de code de module

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

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

Paramètres

-ListAvailable

Indique que cette applet de commande obtient des extraits de code des modules installés sur l’ordinateur, même si les modules ne sont pas importés dans la session active. Si ce paramètre est omis et que le module spécifié par le paramètre Module n’est pas importé dans la session active, la tentative d’obtention des extraits de code du module échoue.

Ce paramètre est valide uniquement lorsque le paramètre Module est utilisé dans la commande.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Module

Importe des extraits de code du module spécifié dans la session active. Les caractères génériques ne sont pas pris en charge.

Ce paramètre importe des extraits de code à partir de Snippet.ps1xml fichiers dans le sous-répertoire Extraits de code dans le chemin du module, par $HOME\Documents\WindowsPowerShell\Modules\<ModuleName>\Snippetsexemple .

Ce paramètre est conçu pour être utilisé par les auteurs de modules dans un script de démarrage, tel qu’un script spécifié dans la clé ScriptsToProcess d’un manifeste de module. Les extraits de code d’un module ne sont pas importés automatiquement avec le module, mais vous pouvez utiliser une Import-IseSnippet commande pour les importer.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Path

Spécifie le chemin d’accès au répertoire d’extraits de code dans lequel cette applet de commande importe des extraits de code.

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:True

-Recurse

Indique que cette applet de commande importe des extraits de code à partir de tous les sous-répertoires de la valeur du paramètre Path .

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
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

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

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

  • L’applet New-IseSnippet de commande 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 charger dans 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.

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