Read-Host

Lit une ligne d'entrée à partir de la console.

Syntaxe

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

Description

L'applet de commande Read-Host lit une ligne d'entrée à partir de la console. Vous pouvez l'utiliser pour inviter un utilisateur à entrer du contenu. Étant donné que vous pouvez enregistrer l'entrée en tant qu'une chaîne sécurisée, vous pouvez utiliser cette applet de commande pour inviter les utilisateurs à entrer des données sécurisées, telles que des mots de passe, ainsi que des données partagées.

Paramètres

-AsSecureString

Affiche des astérisques (*) à la place des caractères saisis par les utilisateurs.

Lorsque vous utilisez ce paramètre, la sortie de l'applet de commande Read-Host est un objet SecureString (System.Security.SecureString).

Obligatoire ?	false
Position ?	named
Valeur par défaut
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Prompt <Object>

Spécifie le texte de l'invite. Tapez une chaîne. Si la chaîne inclut des espaces, mettez-la entre guillemets. Par exemple, « Tapez un entier : ».

Obligatoire ?	false
Position ?	1
Valeur par défaut
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

<CommonParameters>

Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.

Entrées et sorties

Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.

Entrées

Aucun

Vous ne pouvez pas diriger d'entrée vers cette applet de commande.

Sorties

System.String ou System.Security.SecureString

Si le paramètre AsSecureString est utilisé, l'applet de commande Read-Host retourne un objet SecureString. Sinon, elle retourne une chaîne.

Exemple 1

C:\PS>$age = read-host "Please enter your age:"

Description
-----------
Cette commande affiche la chaîne « Please enter your age : » en tant qu'invite. Lorsqu'un utilisateur entre une valeur et appuie sur la touche ENTRÉE, la valeur est stockée dans la variable $age.

Exemple 2

C:\PS>$pwd_secure_string = read-host "Enter a Password:" -assecurestring

Description
-----------
Cette commande affiche la chaîne « Enter a password : » en tant qu'invite. Lorsqu'un utilisateur entre une valeur, des astérisques (*) apparaissent sur la console au lieu des caractères saisis. Lorsque l'utilisateur appuie sur la touche ENTRÉE, la valeur est stockée en tant qu'objet SecureString dans la variable $pwd_secure_string.