從主控台讀取一行輸入。

語法

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

描述

Read-Host Cmdlet 會從主控台讀取一行輸入。您可以用它來提示使用者輸入。由於您可以將輸入另存成安全字串,因此可以使用此 Cmdlet 提示使用者輸入安全資料 (如密碼) 以及共用資料。

參數

-AsSecureString

顯示星號 (*) 以取代使用者在輸入時所輸入的字元。

使用此參數時,Read-Host Cmdlet 的輸出會是 SecureString 物件 (System.Security.SecureString)。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

-Prompt <Object>

指定提示的文字。請輸入字串。如果字串包含空格,請將其置於引號內。例如,輸入 "Type an integer: "。

必要?

false

位置?

1

預設值

接受管線輸入?

false

接受萬用字元?

false

<CommonParameters>

這個 Cmdlet 支援一般參數:-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。如需詳細資訊,請參閱 about_Commonparameters.

輸入和輸出

輸入型別是可經由管道輸出至 Cmdlet 的物件型別。傳回型別則是 Cmdlet 所傳回的物件型別。

輸入

您無法經由管道將輸入輸出至這個 Cmdlet。

輸出

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 變數。






請參閱




目錄