Utilisation de fonctions

Les fonctions sont un type de commande dans Windows PowerShell. Vous exécutez une fonction en tapant son nom, comme vous le feriez pour une applet de commande. Tout comme les applets de commande, les fonctions peuvent avoir des paramètres. Les fonctions peuvent utiliser des objets .NET en entrée et retourner des objets .NET en sortie tout comme les applets de commande. Concrètement, les fonctions peuvent faire pratiquement tout ce que les applets de commande font.

L'aspect le plus intéressant concernant les fonctions est qu'elles sont vraiment faciles à écrire. Contrairement aux applets de commande, qui sont écrites en C#, les fonctions sont simplement un regroupement nommé de commandes et d'expressions Windows PowerShell. Si vous savez taper des commandes dans Windows PowerShell, vous pouvez écrire des fonctions.

Les fonctions sont des commandes. Par conséquent, pour rechercher des fonctions, utilisez l'applet de commande Get-Command.

Par exemple, pour rechercher toutes les fonctions de votre session, tapez :

get-command -CommandType function

Windows PowerShell comprend également un lecteur Function: qui contient toutes les fonctions de votre session. Pour naviguer dans le lecteur Function:, utilisez les mêmes méthodes que pour naviguer dans les lecteurs de système de fichiers.

Pour accéder au lecteur Function, tapez :

cd function:

Pour afficher les fonctions du lecteur Function, tapez :

dir function:

Pour exécuter une fonction, tapez simplement son nom. Par exemple, pour exécuter la fonction Clear-Host, tapez :

clear-host

Dans la Console Windows PowerShell, la fonction Clear-Host supprime tout le texte de la fenêtre de la console. Elle peut se comporter différemment ou n'avoir aucun effet dans d'autres programmes d'hébergement.

Pour utiliser les paramètres d'une fonction, tapez le nom du paramètre précédé d'un trait d'union et suivi d'une valeur, comme vous le feriez pour les paramètres d'une applet de commande.

Par exemple, la fonction Help, qui affiche les rubriques d'aide page par page, a les mêmes paramètres que l'applet de commande Get-Help. Pour utiliser la fonction Help afin de recevoir uniquement les exemples de la rubrique d'aide de l'applet de commande Get-Service, tapez :

help -name get-service -examples

Les fonctions peuvent avoir des rubriques d'aide. Pour rechercher la rubrique d'aide d'une fonction, utilisez l'applet de commande Get-Help. Il s'agit de la même applet de commande que celle que vous utilisez pour obtenir de l'aide sur les applets de commande.

Par exemple, pour obtenir de l'aide sur la fonction Disable-PSRemoting, tapez :

get-help Disable-PSRemoting

Vous pouvez utiliser tous les paramètres de l'applet de commande Get-Help pour obtenir de l'aide sur les fonctions. Par exemple, pour obtenir uniquement les exemples de la rubrique d'aide de la fonction Disable-PSRemoting, tapez :

get-help Disable-PSRemoting -example

Une fonction est un groupe nommé de commandes ou d'expressions. Pour écrire une fonction simple, utilisez le format suivant.

function <name> { <commands> }

Tapez simplement function, le nom de la fonction, puis placez les commandes entre accolades ({ }).

Par exemple, si vous tapez fréquemment une commande particulière, telle que get-help get-member -examples, vous pouvez gagner du temps en écrivant une fonction qui exécute la commande. La fonction suivante, appelée GMEX, exécute la commande.

function GMEX {get-help get-member -examples}

Après avoir tapé la fonction à l'invite Windows PowerShell (ou l'avoir copiée-collée à partir de cette rubrique) et appuyé sur ENTRÉE, vous pouvez utiliser la fonction dans votre session. Pour exécuter la fonction, tapez GMEX.

Il s'agit d'une fonction simple, mais avec seulement quelques lignes supplémentaires, vous pouvez ajouter des paramètres, rendre des paramètres facultatifs ou obligatoires, ajouter des messages utilisateur et ajouter une rubrique d'aide pour votre fonction. À mesure que vous renforcerez vos connaissances concernant Windows PowerShell, vous pourrez écrire des fonctions avancées ayant toutes les fonctionnalités des applets de commande.

Pour plus d'informations sur l'écriture de fonctions, consultez about_Functions, about_Comment_Based_Help et about_Functions_Advanced.

Lorsque vous ouvrez Windows PowerShell, vous êtes dans une session Windows PowerShell. La session dure jusqu'à ce que vous fermiez la fenêtre Windows PowerShell (ou tapiez Exit pour mettre fin à la session). À moins que vous n'enregistriez un élément dans un fichier sur le disque ou que vous l'enregistriez dans le Registre, les éléments que vous créez dans votre session sont supprimés lorsque votre session prend fin.

Pour enregistrer les fonctions que vous écrivez afin qu'elles soient disponibles dans les futures sessions Windows PowerShell, créez un profil Windows PowerShell et enregistrez vos fonctions dans votre profil.

Pour plus d'informations, consultez about_Profiles.