コンソールから入力を 1 行読み取ります。
構文
Read-Host [[-Prompt] <Object>] [-AsSecureString] [<CommonParameters>]
説明
Read-Host コマンドレットはコンソールから入力を 1 行読み取ります。これを使用して、ユーザーに入力を求めることができます。入力をセキュリティで保護された文字列として保存できるため、このコマンドレットを使用して、共有データだけでなく、パスワードなどのセキュリティで保護されるデータをユーザーに求めることができます。
パラメーター
-AsSecureString
ユーザーが入力する文字の代わりにアスタリスク (*) が表示されます。
このパラメーターを使用する場合、Read-Host コマンドレットの出力は SecureString オブジェクトです (System.Security.SecureString)。
|
必須 |
false |
|
位置 |
named |
|
既定値 |
|
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
-Prompt <Object>
プロンプトのテキストを指定します。文字列を入力します。文字列にスペースが含まれる場合は、二重引用符で囲みます。たとえば、「"Type an integer: "」と入力します。
|
必須 |
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:" という文字列をプロンプトとして表示します。値が入力されて Enter キーが押されると、その値は $age 変数に保存されます。
例 2
C:\PS>$pwd_secure_string = read-host "Enter a Password:" -assecurestring 説明 ----------- このコマンドは、"Enter a Password:" という文字列をプロンプトとして表示します。値が入力されると、入力値の代わりにアスタリスク (*) がコンソールに表示されます。Enter キーが押されると、入力された値は SecureString オブジェクトとして $pwd_secure_string 変数に保存されます。
関連項目