about_Return

Aplica-se a: Windows PowerShell 2.0, Windows PowerShell 3.0, Windows PowerShell 4.0, Windows PowerShell 5.0

TÓPICO

about_Return

DESCRIÇÃO BREVE

Sai do escopo atual, que pode ser uma função, um script ou um bloco de script.

DESCRIÇÃO LONGA

A palavra-chave Return sai de uma função, um script ou um bloco de script. Ela pode ser usada para sair de um escopo em um momento específico, para retornar um valor ou para indicar que foi alcançado o final do escopo.

Os usuários que estão familiarizados com linguagens como C ou C# talvez queiram usar a palavra-chave Return para tornar a lógica de deixar um escopo explícita.

Em Windows PowerShell®, os resultados de cada instrução são retornados como saída, mesmo sem uma instrução que contém a palavra-chave Return. As linguagens como C ou C# retornam apenas o valor ou valores que são especificados da palavra-chave Return.

SINTAXE

A sintaxe para a palavra-chave Return é a seguinte:

          return [<expression>]

A palavra-chave Return pode aparecer sozinha ou pode ser seguida por um valor ou expressão, da seguinte maneira:

          return
          return $a
          return (2 + $a)

EXEMPLOS

O exemplo a seguir usa a palavra-chave Return para sair de uma função em um momento específico se uma condicional for atendida:

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

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

Esse script verifica cada conta de usuário. A função ScreenPassword retorna o nome de qualquer conta de usuário que não tenha um protetor de tela protegido por senha. Se a proteção de tela for protegida por senha, a função concluirá qualquer outra instrução a ser executada, e Windows PowerShell não retorna nenhum valor.

          $a
          return

A instrução a seguir também retorna o valor do corpo da seção $a:Insert aqui.

          return $a

O exemplo a seguir inclui uma instrução que pretende permitir que o usuário saiba que a função está executando um cálculo:

          function calculation {
              param ($value)

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

A execução dessa função e a atribuição do resultado a uma variável têm o seguinte efeito:

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

A cadeia de caracteres "Aguarde. Trabalhando no cálculo..." não é exibida. Em vez disso, ela é atribuída à variável $a, como no exemplo a seguir:

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

A cadeia de caracteres informativa e o resultado do cálculo são retornados pela função e atribuídos à variável $a.

CONSULTE TAMBÉM

Palavra-chave de saída em about_Language_Keywords

about_Functions

about_Scopes

about_Script_Blocks