Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Read-Host

Read-Host

microsoft.powershell.commands.utility.dll

Synopsis

Reads a line of input from the console.

Syntax

Read-Host [-Prompt] [-AsSecureString] [<CommonParameters>]

Detailed Description

The Read-Host cmdlet reads a line of input from the console. You can use it to prompt a user for input. Because you can save the input as a secure string, you can use this cmdlet to prompt users for secure data, such as passwords, as well as shared data.

Parameters

-AsSecureString <SwitchParameter>

Displays asterisks (*) in place of the characters that the user types as input.

When you use this parameter, the output of the Read-Host cmdlet is a SecureString object (System.Security.SecureString).

Aliases

None

Required?

false

Position

named

Default value

False

Accept pipeline input?

false

Accept wildcard characters?

false

-Prompt <Object>

Specifies the text of the prompt. Type a string. If the string includes spaces, enclose it in quotation marks. Windows PowerShell appends a colon (:) to the text that you enter.

Aliases

None

Required?

false

Position

1

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

System.String or System.Security.SecureString

Notes

None

Examples

-------------------------- EXAMPLE 1 --------------------------

This command displays the string "Please enter your age:" as a prompt. When a value is entered and the Enter key is pressed, the value is stored in the $age variable.

PS C:\>$age = read-host "Please enter your age"

-------------------------- EXAMPLE 2 --------------------------

This command displays the string "Enter a Password:" as a prompt. As a value is being entered, asterisks (*) appear on the console in place of the input. When the Enter key is pressed, the value is stored as a SecureString object in the $pwd_secure_string variable.

PS C:\>$pwd_secure_string = read-host "Enter a Password" -assecurestring

Online Version
Clear-Host
ConvertFrom-SecureString
Get-Host
Out-Host
Write-Host