Read-Host

项目
10/30/2009

从控制台读取一行输入。

语法

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

说明

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

参数

-AsSecureString

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

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

是否为必需？	false
位置？	named
默认值
是否接受管道输入？	false
是否接受通配符？	false

-Prompt <Object>

指定提示的文本。键入一个字符串。如果该字符串包括空格，请将其括在引号中。例如，"Type an integer: "。

是否为必需？	false
位置？	1
默认值
是否接受管道输入？	false
是否接受通配符？	false

<CommonParameters>

此 cmdlet 支持通用参数：-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。有关详细信息，请参阅 about_Commonparameters.

输入和输出

输入类型是指可通过管道传递给 cmdlet 的对象的类型。返回类型是指 Cmdlet 所返回对象的类型。

输入

无

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

输出

System.String 或 System.Security.SecureString

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

示例 1

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

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

示例 2

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

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

另请参阅

概念

Get-Host
Out-Host
Write-Host
ConvertFrom-SecureString

通过