HOME > Host系コマンドレット > Read-Host
Read-Host
Read-Hostは、入力文字列を読み取るコマンドです。
エイリアスなし
解説
コンソールから文字の入力を受け付けます。
セキュア文字列として入力値を保護した形式での入力も可能です。
構文
- （構文）
- Read-Host [[-Prompt] <Object>] [<CommonParameters>]
| パラメータ | 説明 |
|---|---|
| -Prompt 文字列 | プロンプトを指定する （例） -Prompt "名前を入力してください。" |
| -AsSecureString | セキュア文字列として入力する ※入力中の文字は*で表示され、結果はSecureStringオブジェクトになります。 |
共通的なパラメータは「共通パラメータ」をご覧ください。
サンプル
入力を受け付けて変数aに代入する
PS C:\> $a = Read-Host -Prompt "入力してください"
入力してください: hoge
PS C:\> Write-Host $a
hoge
セキュア文字列として入力を受け付けて変数aに代入する
PS C:\> $a = Read-Host -Prompt "入力してください" -AsSecureString
入力してください: ****
PS C:\> Write-Host $a
System.Security.SecureString
コマンドのヘルプを表示する
Get-Help Read-Host
備考
- パラメータ名の「-Prompt」は省略可能です。
関連項目
- Host系コマンドレット
- Write-Host：コンソールに文字列を出力する
- Clear-Host：コンソールをクリアする
- Get-Host：ホストオブジェクトを取得する
- Out-Host：オブジェクトをコンソールに出力する
- Read-Host：入力文字列を読み取る
