Read-Host
從主控台讀取一行輸入。
語法
Read-Host
[[-Prompt] <Object>]
[-AsSecureString]
[<CommonParameters>]
Description
Read-Host Cmdlet 會從控制台讀取一行輸入。 您可以使用它來提示使用者輸入。 因為您可以將輸入儲存為安全字串,因此您可以使用此 Cmdlet 來提示使用者輸入安全數據,例如密碼,以及共用數據。
範例
範例 1:將主控台輸入儲存至變數
PS C:\> $Age = Read-Host "Please enter your age"
此命令會顯示字串 「請輸入您的年齡:」作為提示。 輸入值並按下 Enter 鍵時,該值會儲存在$Age變數中。
範例 2:將主控台輸入儲存為安全字串
PS C:\> $pwd_secure_string = Read-Host "Enter a Password" -AsSecureString
此命令會顯示字串 “Enter a Password:” 作為提示。 輸入值時,星號 \ 會出現在控制台中,以取代輸入。 按下 Enter 鍵時,值會儲存為 $pwd_secure_string 變數中的 SecureString 物件。
參數
-AsSecureString
指出 Cmdlet 會顯示星號 。 會取代使用者輸入為輸入的字元。
當您使用此參數時,Read-Host Cmdlet 的輸出是 SecureString 物件(System.Security.SecureString)。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-Prompt
指定提示的文字。 輸入字串。 如果字串包含空格,請以引弧括住它。 Windows PowerShell 會將冒號 (:)附加至您輸入的文字。
類型: | Object |
Position: | 0 |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
輸入
None
您無法使用管線將輸入傳送至此 Cmdlet。
輸出
System.String or System.Security.SecureString
如果使用 AsSecureString 參數,Read-Host 會傳回 SecureString。 否則,它會傳回字串。