Partager via

Get-IseSnippet

  • Référence
Module:
ISE

Obtient les extraits de code créés par l'utilisateur.

Syntaxe

Get-IseSnippet []

Description

L’applet Get-IseSnippet de commande obtient les fichiers PS1XML qui contiennent des extraits de texte réutilisables que l’utilisateur a créés. Il fonctionne uniquement dans l’environnement de script intégré Windows PowerShell (ISE).

Lorsque vous utilisez l’applet New-IseSnippet de commande pour créer un extrait de code, New-IseSnippet crée un <SnippetTitle>.Snippets.ps1xml fichier dans le $HOME\Documents\WindowsPowerShell\Snippets répertoire. Get-IseSnippet obtient les fichiers d’extraits de code dans le répertoire Extraits de code.

Cette applet de commande n’obtient pas d’extraits de code intégrés ni d’extraits de code importés à partir de modules via l’applet Import-IseSnippet de commande.

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

Exemples

Exemple 1 : Obtenir tous les extraits définis par l’utilisateur

Cet exemple obtient tous les extraits de code définis par l’utilisateur dans le répertoire Extraits de code.

Get-IseSnippet

Exemple 2 : Copier tous les extraits définis par l’utilisateur à partir d’ordinateurs distants vers un répertoire partagé

Cet exemple copie tous les extraits de code créés par l’utilisateur à partir d’un groupe d’ordinateurs distants vers un répertoire d’extraits de code partagé.

Invoke-Command -Computer (Get-Content Servers.txt) {Get-IseSnippet | Copy-Item -Destination \\Server01\Share01\Snippets}

Invoke-Command s’exécute Get-IseSnippet sur les ordinateurs du Servers.txt fichier. Un opérateur de pipeline (|) envoie les fichiers d’extraits de code à l’applet Copy-Item de commande, qui les copie dans le répertoire spécifié par le paramètre de destination .

Exemple 3 : Afficher le titre et le texte de chaque extrait de code sur un ordinateur local

Cet exemple utilise les applets de commande et Select-Xml les Get-IseSnippet applets de commande pour afficher le titre et le texte de chaque extrait de code sur l’ordinateur local.

#Parse-Snippet Function
function Parse-Snippet {
  $SnippetFiles = Get-IseSnippet
  $SnippetNamespace = @{x="http://schemas.microsoft.com/PowerShell/Snippets"}
  foreach ($SnippetFile in $SnippetFiles) {
     Write-Host ""
     $Title = Select-Xml -Path $SnippetFile.FullName -Namespace $SnippetNamespace -XPath "//x:Title" |
       ForEach-Object {$_.Node.InnerXML}
     $Text = Select-Xml -Path $SnippetFile.FullName -Namespace $SnippetNamespace -XPath "//x:Script" |
       ForEach-Object {$_.Node.InnerText}
     Write-Host "Title: $Title"
     Write-Host "Text: $Text"
   }
}

Title: Mandatory
Text:
Param
(
  [parameter(Mandatory=True)]
  [String[]]
  $<ParameterName>
)

Title: Copyright
Text:  (c) Fabrikam, Inc. 2012

Exemple 4 : Afficher le titre et la description de tous les extraits de code dans la session

Cet exemple montre comment afficher le titre et la description de tous les extraits de code de la session, notamment les extraits intégrés, les extraits définis par l’utilisateur et les extraits importés.

$PSISE.CurrentPowerShellTab.Snippets | Format-Table DisplayTitle, Description

La $PSISE variable représente le programme hôte Windows PowerShell ISE. La propriété CurrentPowerShellTab de la $PSISE variable représente la session active. La propriété Extraits de code représente des extraits de code dans la session active.

La $PSISE.CurrentPowerShellTab.Snippets commande renvoie un objet Microsoft.PowerShell.Host.ISE.ISESnippet qui représente un extrait de code, contrairement à l’applet Get-IseSnippet de commande. Get-IseSnippet retourne un objet de fichier (System.Io.FileInfo) qui représente un fichier d’extrait de code.

L’applet Format-Table de commande affiche les propriétés DisplayTitle et Description des extraits de code d’une table.

Entrées

None

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

Sorties

FileInfo

Cette applet de commande retourne un objet de fichier représentant le fichier d’extrait de code.

Notes

  • 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 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.

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