通过

Read-Host

  • 参考
模块:
Microsoft.PowerShell.Utility

从控制台读取一行输入。

语法

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

说明

读取主机 cmdlet 从控制台读取一行输入。 可以使用它提示用户输入。 由于可以将输入保存为安全字符串，因此可以使用此 cmdlet 提示用户输入安全数据，例如密码和共享数据。

示例

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

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

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

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

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

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

参数

-AsSecureString

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

使用此参数时，Read-Host cmdlet 的输出是 SecureString 对象（System.Security.SecureString）。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Prompt

指定提示的文本。 键入字符串。 如果字符串包含空格，请用引号将其括起来。 Windows PowerShell 将冒号（:)附加到输入的文本）。

类型:Object
Position:0
默认值:None
必需:False
接受管道输入:False
接受通配符:False

输入

None

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

输出

System.String or System.Security.SecureString

如果使用 AsSecureString 参数，读取主机 返回 SecureString。 否则，它将返回一个字符串。