about_Return

Mis à jour: août 2012

S'applique à: Windows PowerShell 2.0, Windows PowerShell 3.0

RUBRIQUE

about_Return

DESCRIPTION COURTE

Quitte la portée active (fonction, script ou bloc de script).

DESCRIPTION DÉTAILLÉE

Le mot clé Return quitte une fonction, un script ou un bloc de script. Il peut être utilisé pour quitter une portée à un moment précis, pour retourner une valeur ou pour indiquer que la fin de la portée a été atteinte.

Les utilisateurs familiarisés avec les langages tels que le C ou le C# peuvent utiliser le mot clé Return pour rendre explicite la logique qui amène à quitter une portée.

Dans Windows PowerShell®, les résultats de chaque instruction sont retournés en tant que sortie, même si aucune instruction ne contient de mot clé Return. Les langages comme le C ou le C# retournent uniquement la ou les valeurs spécifiées par le mot clé Return.

SYNTAXE

La syntaxe du mot-clé Return est la suivante :

          return [<expression>]

Le mot clé Return peut apparaître seul, ou il peut être suivi d'une valeur ou d'une expression, comme ceci :

          return
          return $a
          return (2 + $a)

EXEMPLES

L'exemple suivant utilise le mot clé Return pour quitter une fonction à un moment précis si une condition est remplie :

          function ScreenPassword($instance)
          {
              if (!($instance.screensaversecure)) {return $instance.name} 
              <additional statements>
          }

          foreach ($a in @(get-wmiobject win32_desktop)) { ScreenPassword($a) }

Ce script vérifie chaque compte d'utilisateur. La fonction ScreenPassword retourne le nom des comptes d'utilisateurs qui ne disposent pas d'un écran de veille protégé par un mot de passe. Si l'écran de veille est protégé par un mot de passe, la fonction termine toutes les autres instructions devant être exécutées, et Windows PowerShell ne retourne pas de valeur.

          $a
          return

L'instruction suivante retourne également la valeur $a :

          return $a

L'exemple suivant inclut une instruction destinée à informer l'utilisateur que la fonction effectue un calcul :

          function calculation {
              param ($value)

              "Please wait. Working on calculation..."
              $value += 73
              return $value
              }

L'exécution de cette fonction et l'attribution du résultat à une variable ont l'effet suivant :

          C:\PS> $a = calculation 14
          C:\PS>

La chaîne "Veuillez patienter. Calcul en cours..." n'est pas affichée. Au lieu de cela, elle est attribuée à la variable $a, comme dans l'exemple suivant :

          C:\PS> $a
          Please wait. Working on calculation...
          87

La chaîne d'information et le résultat du calcul sont retournés par la fonction et attribués à la variable $a.

VOIR AUSSI

Mot clé Exit dans about_Language_Keywords

about_Functions

about_Scopes

about_Script_Blocks