PowerShell Cmdlet - Read-Host
 記事記号:[mg1948] 初版:2011/Sep/30

この文書は、Windows PowerShellのヘルプ機能で表示される内容を再構成したものです。

名前
    Read-Host
    
概要
    コンソールから入力を 1 行読み取ります。
    
構文
    Read-Host [[-Prompt] <Object>] [-AsSecureString] [<CommonParameters>]
    
説明
    Read-Host コマンドレットはコンソールから入力を 1 行読み取ります。これを使用
    して、ユーザーに入力を求めることができます。入力をセキュリティで保護された文
    字列として保存できるため、このコマンドレットを使用して、共有データだけでなく、
    パスワードなどのセキュリティで保護されるデータをユーザーに求めることができま
    す。

パラメーター
    -AsSecureString [<SwitchParameter>]
        ユーザーが入力する文字の代わりにアスタリスク (*) が表示されます。
        
        このパラメーターを使用する場合、Read-Host コマンドレットの出力は SecureS
        tring オブジェクトです (System.Security.SecureString)。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Prompt <Object>
        プロンプトのテキストを指定します。文字列を入力します。文字列にスペースが
        含まれる場合は、二重引用符で囲みます。たとえば、「"Type an integer:  "」
        と入力します。
        
        必須                         false
        位置                         1
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help 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_se
    cure_string 変数に保存されます。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113371
    Get-Host 
    Out-Host 
    Write-Host 
    ConvertFrom-SecureString 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、Read-Host
ご利用数: 1856901
感想・要望・問い合わせは こちら