Read-Host

从控制台读取一行输入。

语法

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

说明

Read-Host cmdlet 从控制台读取一行输入。 可使用它来提示用户输入数据。 因为可以将输入保存为安全字符串,所以可以使用此 cmdlet 来提示用户输入安全数据(如密码)以及共享的数据。

示例

示例 1:将控制台输入保存到变量

PS C:\> $Age = Read-Host "Please enter your age"

此命令显示字符串“Please enter your age:”作为提示。 输入值并按 Enter 键时,该值存储在 $Age 变量中。

示例 2:将控制台输入另存为安全字符串

PS C:\> $pwd_secure_string = Read-Host "Enter a Password" -AsSecureString

此命令显示字符串“Enter a Password:”作为提示。 输入值时,控制台中显示星号 (*) 来替代输入。 按 Enter 键时,该值将作为 SecureString 对象存储在 $pwd_secure_string 变量中。

参数

-AsSecureString

指示 cmdlet 显示星号 (*) 代替用户键入为输入的字符。

使用此参数时, Read-Host cmdlet 的输出是 一个 SecureString 对象, (System.Security.SecureString) 。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Prompt

指定提示的文本。 键入一个字符串。 如果该字符串包含空格,请将其括在引号中。 Windows PowerShell 将一个冒号 (:) 附加到你输入的文本。

Type:Object
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

输入

None

不能通过管道将输入传递给此 cmdlet。

输出

System.String or System.Security.SecureString

如果使用 AsSecureString 参数, Read-Host 将返回 SecureString。 否则,它将返回一个字符串。