通过

Read-Host

  • 参考
模块:
Microsoft.PowerShell.Utility

从控制台读取一行输入。

语法

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

说明

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

示例

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

此示例显示字符串“请输入你的年龄：”作为提示。 输入值并按下 Enter 键时，该值将存储在 变量中 $Age 。

$Age = Read-Host "Please enter your age"

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

此示例显示字符串“输入密码：”作为提示。 输入值时，主机上会显示星号 (*) 代替输入。 按下 Enter 键时，该值将作为 SecureString 对象存储在 变量中 $pwd_secure_string 。

$pwd_secure_string = Read-Host "Enter a Password" -AsSecureString

参数

-AsSecureString

指示 cmdlet 显示星号 (*) 代替用户键入为输入的字符。 使用此参数时，cmdlet 的Read-Host输出是 System.Security.SecureString) (SecureString 对象。

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

-Prompt

指定提示的文本。 键入一个字符串。 如果该字符串包含空格，请将其括在引号中。 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。 否则，它将返回一个字符串。