about_Return

Se aplica a: Windows PowerShell 2.0, Windows PowerShell 3.0, Windows PowerShell 4.0

TEMA

about_Return

DESCRIPCIÓN BREVE

Sale del ámbito actual, que puede ser una función, un script o un bloque de script.

DESCRIPCIÓN LARGA

La palabra clave Return sale de una función, un script o un bloque de script. Se puede usar para salir de un ámbito en un momento concreto, para devolver un valor o para indicar que se alcanzó el final del ámbito.

Los usuarios familiarizados con lenguajes como C o C# podrían estar interesados en usar la palabra clave Return para explicitar la lógica de salir de un ámbito.

En Windows PowerShell®, los resultados de cada instrucción se devuelven como salida, incluso sin una instrucción que contenga la palabra clave Return. Los lenguajes como C o C# solo devuelven el valor o valores que se especifican mediante la palabra clave Return.

SINTAXIS

La sintaxis de la palabra clave Return es la siguiente:

          return [<expression>]

La palabra clave Return puede aparecer sola o seguida de un valor o expresión, como se indica a continuación:

          return
          return $a
          return (2 + $a)

EJEMPLOS

El ejemplo siguiente usa la palabra clave Return para salir de una función en un momento concreto si se cumple una instrucción condicional:

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

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

Este script comprueba cada cuenta de usuario. La función ScreenPassword devuelve el nombre de todas las cuentas de usuario que no tengan un protector de pantalla protegido por contraseña. Si el protector de pantalla está protegido por contraseña, la función completa las demás instrucciones que haya que ejecutar y Windows PowerShell no devuelve ningún valor.

          $a
          return

La instrucción siguiente también devuelve el valor de $a:Insert section body here.

          return $a

En el ejemplo siguiente se incluye una instrucción diseñada para indicarle al usuario que la función realiza un cálculo:

          function calculation {
              param ($value)

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

El efecto de ejecutar esta función y asignar el resultado a una variable es el siguiente:

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

La cadena "Please wait. Working on calculation..." no se muestra. En su lugar, se asigna a la variable $a, como en el ejemplo siguiente:

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

La función devuelven la cadena informativa y el resultado del cálculo y estos se asignan a la variable $a.

VEA TAMBIÉN

Palabra clave Exit en about_Language_Keywords

about_Functions

about_Scopes

about_Script_Blocks