Lê uma linha da entrada do console.
Sintaxe
Read-Host [[-Prompt] <Object>] [-AsSecureString] [<CommonParameters>]
Descrição
O cmdlet Read-Host lê uma linha de entrada do console. Você pode usá-la para solicitar uma entrada ao usuário. Como você pode salvar a entrada como uma cadeia de caracteres de segurança, pode usar este cmdlet para solicitar dados seguros aos usuários, como senhas, e compartilhar dados.
Parâmetros
-AsSecureString
Exibe asteriscos (*) no lugar dos caracteres que o usuário digita como entrada.
Ao utilizar este parâmetro, a saída do cmdlet Read-Host é um objeto SecureString (System.Security.SecureString).
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-Prompt <Object>
Especifica o texto da mensagem. Digite uma cadeia de caracteres. Se a cadeia de caracteres incluir espaços, coloque-a entre aspas. Por exemplo, "Digite um inteiro: ".
|
Necessário? |
false |
|
Posição? |
1 |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
<CommonParameters>
Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.
Entradas e saídas
O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.
|
Entradas |
None Você não pode canalizar a entrada para este cmdlet. |
|
Saídas |
System.String ou System.Security.SecureString Se o parâmetro AsSecureString for usado, Read-Host devolverá um SecureString. Caso contrário, retorna uma cadeia de caracteres. |
Exemplo 1
C:\PS>$age = read-host "Please enter your age:" Descrição ----------- Este comando exibe a cadeia de caracteres "Please enter your age:" como um prompt. Quando um valor for inserido e a tecla Enter pressionada, esse valor será armazenado na variável $age.
Exemplo 2
C:\PS>$pwd_secure_string = read-host "Enter a Password:" -assecurestring Descrição ----------- Este comando apresenta a cadeia de caracteres "Enter a Password:" como um prompt. Como está sendo inserido um valor, asteriscos (*) aparecem no console no lugar da entrada. Quando a tecla Enter for pressionada, o valor será armazenado como um objeto SecureString na variável $pwd_secure_string.
See Also