Read-Host

Считывает из консоли строку ввода.

Синтаксис

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

Описание

Командлет Read-Host считывает из консоли строку ввода. Эту команду можно использовать для запроса данных у пользователя. Поскольку вводимые данные можно сохранить в виде защищенной строки, с помощью этой команды можно запрашивать у пользователей конфиденциальные данные, например пароли, а также общие данные.

Параметры

-AsSecureString

Отображает звездочки (*) вместо вводимых пользователем знаков.

При использовании этого параметра выводом командлета Read-Host является объект SecureString (System.Security.SecureString).

Обязательно?	false
Позиция?	named
Значение по умолчанию
Принимать входные данные из конвейера?	false
Принимать подстановочные знаки?	false

-Prompt <Object>

Задает текст сообщения для пользователя. Введите строку. Строку, содержащую пробелы, необходимо заключать в кавычки. Например, "Введите целое число: ".

Обязательно?	false
Позиция?	1
Значение по умолчанию
Принимать входные данные из конвейера?	false
Принимать подстановочные знаки?	false

<CommonParameters>

Данный командлет поддерживает общие параметры -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer и -OutVariable. Дополнительные сведения см. в разделе about_Commonparameters.

Ввод и вывод

Входным типом является тип объектов, которые можно передавать командлету по конвейеру. Возвращаемым типом является тип объектов, возвращаемых командлетом.

Входные данные

Нет

Передать входные данные этому командлету по конвейеру невозможно.

Выходные данные

System.String или System.Security.SecureString

В случае использования параметра AsSecureString командлет Read-Host возвращает объект SecureString. В противном случае будет возвращена обычная строка.

Пример 1

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

Описание
-----------
Эта команда выводит запрос "Please enter your age:" (Введите свой возраст:). После ввода значения и нажатия клавиши ВВОД введенное значение сохраняется в переменной $age.

Пример 2

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

Описание
-----------
Эта команда выводит запрос "Enter a Password:" (Введите пароль:). При вводе значения вместо вводимых символов появляются звездочки (*). При нажатии клавиши ВВОД введенное значение будет сохранено в переменной $pwd_secure_string как объект SecureString.