about_Language_Keywords
Description courte
Décrit les mots clés dans le langage de script PowerShell.
Description longue
PowerShell contient les mots clés de langue suivants. Pour plus d’informations, consultez la rubrique about pour le mot clé et les informations qui suivent le tableau.
Les mots clés suivants sont utilisés par les workflows PowerShell :
inlinescript
parallel
sequence
workflow
Les workflows PowerShell sont uniquement pris en charge dans PowerShell 5.1. Pour plus d’informations sur les flux de travail, consultez Exécution de commandes PowerShell dans un flux de travail.
begin
Spécifie une partie du corps d’une fonction, ainsi que les dynamicparam
mots clés , process
et end
. La begin
liste d’instructions s’exécute une fois avant que des objets ne soient reçus à partir du pipeline.
Syntaxe :
function <name> {
dynamicparam {<statement list>}
begin {<statement list>}
process {<statement list>}
end {<statement list>}
}
break
Provoque la sortie d’une boucle d’un script.
Syntaxe :
while (<condition>) {
<statements>
...
break
...
<statements>
}
catch
Spécifie une liste d’instructions à exécuter si une erreur se produit dans la liste d’instructions qui l’accompagne try
. Un type d’erreur nécessite des crochets. La deuxième paire de crochets indique que le type d’erreur est facultatif.
Syntaxe :
try {<statement list>}
catch [[<error type>]] {<statement list>}
class
Spécifie une nouvelle classe dans PowerShell.
Syntaxe :
class <class-name> {
[[hidden] [static] <property-definition> ...]
[<class-name>([argument-list>]) {<constructor-statement-list>} ...]
[[hidden] [static] <method-definition> ...]
}
continue
Provoque l’arrêt d’un script d’exécution d’une boucle et le retour à la condition. Si la condition est remplie, le script recommence la boucle.
Syntaxe :
while (<condition>) {
<statements>
...
continue
...
<statements>
}
data
Dans un script, définit une section qui isole les données de la logique de script. Peut également inclure des if
instructions et certaines commandes limitées.
Syntaxe :
data <variable> [-supportedCommand <cmdlet-name>] {<permitted content>}
do
Utilisé avec ou while
until
mot clé comme construction de boucle. PowerShell exécute la liste d’instructions au moins une fois, contrairement à une boucle qui utilise while
.
Syntaxe pour while
:
do {<statement list>} while (<condition>)
Syntaxe pour until
:
do {<statement list>} until (<condition>)
dynamicparam
Spécifie une partie du corps d’une fonction, ainsi que les begin
mots clés , process
et end
. Les paramètres dynamiques sont ajoutés au moment de l’exécution.
Syntaxe :
function <name> {
dynamicparam {<statement list>}
begin {<statement list>}
process {<statement list>}
end {<statement list>}
}
else
Utilisé avec le if
mot clé pour spécifier la liste d’instructions par défaut.
Syntaxe :
if (<condition>) {<statement list>}
else {<statement list>}
elseif
Utilisé avec les if
mots clés et else
pour spécifier des conditions supplémentaires. Le else
mot clé est facultatif.
Syntaxe :
if (<condition>) {<statement list>}
elseif (<condition>) {<statement list>}
else {<statement list>}
end
Spécifie une partie du corps d’une fonction, ainsi que les dynamicparam
mots clés , begin
et end
. La end
liste d’instructions s’exécute une fois après que tous les objets ont été reçus à partir du pipeline.
Syntaxe :
function <name> {
dynamicparam {<statement list>}
begin {<statement list>}
process {<statement list>}
end {<statement list>}
}
enum
enum
est utilisé pour déclarer une énumération ; un type distinct qui se compose d’un ensemble d’étiquettes nommées appelées liste énumératrice.
Syntaxe :
enum <enum-name> {
<label> [= <int-value>]
...
}
exit
Entraîne la fermeture d’un script ou d’un instance PowerShell.
Syntaxe :
exit
exit <exitcode>
Lorsque vous utilisez pwsh
avec le paramètre File , le .ps1
fichier (script) lui-même doit inclure des instructions pour gérer les erreurs ou exceptions qui se produisent pendant l’exécution du script. Vous devez uniquement utiliser l’instruction exit
pour indiquer la status post-exécution du script.
Sur Windows, n’importe quel nombre entre [int]::MinValue
et [int]::MaxValue
est autorisé.
Sous Unix, seuls les nombres positifs entre [byte]::MinValue
et [byte]::MaxValue
sont autorisés. Un nombre négatif dans la plage de -1
à -255
est automatiquement traduit en nombre positif en ajoutant 256. Par exemple, -2
est transformé en 254
.
Dans PowerShell, l’instruction exit
définit la valeur de la $LASTEXITCODE
variable. Dans l’interpréteur de commandes Windows (cmd.exe
), l’instruction exit définit la valeur de la variable d’environnement %ERRORLEVEL%
.
Tout argument non numérique ou en dehors de la plage spécifique à la plateforme est traduit en valeur de 0
.
Dans l’exemple suivant, l’utilisateur définit la valeur de la variable de niveau d’erreur sur 4 en ajoutant exit 4
au fichier test.ps1
de script .
C:\scripts\test>type test.ps1
1
2
3
exit 4
C:\scripts\test>pwsh -file ./test.ps1
1
2
3
C:\scripts\test>echo %ERRORLEVEL%
4
Lorsque vous exécutez pwsh.exe -File <path to a script>
et que le fichier de script se termine par une exit
commande, le code de sortie est défini sur l’argument numérique utilisé avec la exit
commande. Si le script n’a pas exit
d’instruction, le code de sortie est toujours 0
lorsque le script se termine sans erreur ou 1
lorsque le script se termine à partir d’une exception non gérée.
filter
Spécifie une fonction dans laquelle la liste d’instructions s’exécute une fois pour chaque objet d’entrée. Il a le même effet qu’une fonction qui contient uniquement un process
bloc.
Syntaxe :
filter <name> {<statement list>}
finally
Définit une liste d’instructions qui s’exécute après les instructions associées à try
et catch
. Une finally
liste d’instructions s’exécute même si vous appuyez sur CTRL+C pour laisser un script ou si vous utilisez le exit
mot clé dans le script.
Syntaxe :
try {<statement list>}
catch [<error type>] {<statement list>}
finally {<statement list>}
for
Définit une boucle avec une condition.
Syntaxe :
for (<initialize>; <condition>; <iterate>) { <statement list> }
foreach
Définit une boucle à l’aide de chaque membre d’une collection.
Syntaxe :
foreach (<item> in <collection>) { <statement list> }
from
Réservé pour un usage futur.
function
Crée une liste d’instructions nommées de code réutilisable. Vous pouvez nommer l’étendue à laquelle appartient une fonction. Vous pouvez également spécifier un ou plusieurs paramètres nommés à l’aide de la param
mot clé. Dans la liste des instructions de fonction, vous pouvez inclure des dynamicparam
listes d’instructions , begin
, process
et end
.
Syntaxe :
function [<scope:>]<name> {
param ([type]<$pname1> [, [type]<$pname2>])
dynamicparam {<statement list>}
begin {<statement list>}
process {<statement list>}
end {<statement list>}
}
Vous avez également la possibilité de définir un ou plusieurs paramètres en dehors de la liste d’instructions après le nom de la fonction.
Syntaxe :
function [<scope:>]<name> [([type]<$pname1>, [[type]<$pname2>])] {
dynamicparam {<statement list>}
begin {<statement list>}
process {<statement list>}
end {<statement list>}
}
if
Définit un conditionnel.
Syntaxe :
if (<condition>) {<statement list>}
hidden
Masque les membres de la classe des résultats par défaut de l’applet Get-Member
de commande, d’IntelliSense et des résultats de saisie semi-automatique de tabulation.
Syntaxe :
hidden [data type] $member_name
in
Utilisé dans une foreach
instruction pour créer une boucle qui utilise chaque membre d’une collection.
Syntaxe :
foreach (<item> in <collection>){<statement list>}
param
Définit les paramètres d’une fonction.
Syntaxe :
function [<scope:>]<name> {
param ([type]<$pname1>[, [[type]<$pname2>]])
<statement list>
}
process
Spécifie une partie du corps d’une fonction, ainsi que les dynamicparam
mots clés , begin
et end
. Lorsqu’une liste d’instructions process
reçoit une entrée du pipeline, la process
liste d’instructions s’exécute une fois pour chaque élément du pipeline. Si le pipeline ne fournit aucun objet, la liste d’instructions process
ne s’exécute pas. Si la commande est la première commande du pipeline, la liste d’instructions process
s’exécute une seule fois.
Syntaxe :
function <name> {
dynamicparam {<statement list>}
begin {<statement list>}
process {<statement list>}
end {<statement list>}
}
return
PowerShell quitte l’étendue actuelle, comme un script ou une fonction, et écrit l’expression facultative dans la sortie.
Syntaxe :
return [<expression>]
static
Spécifie que la propriété ou la méthode définie est commune à toutes les instances de la classe dans laquelle elle est définie.
Consultez pour obtenir class
des exemples d’utilisation.
switch
Pour case activée plusieurs conditions, utilisez une switch
instruction. L’instruction switch
équivaut à une série d’instructions if
, mais elle est plus simple.
L’instruction switch
répertorie chaque condition et une action facultative. Si une condition est obtenue, l’action est effectuée.
Syntaxe 1 :
switch [-regex|-wildcard|-exact][-casesensitive] ( <value> )
{
<string>|<number>|<variable>|{ <expression> } {<statement list>}
<string>|<number>|<variable>|{ <expression> } {<statement list>}
...
default {<statement list>}
}
Syntaxe 2 :
switch [-regex|-wildcard|-exact][-casesensitive] -file <filename>
{
<string>|<number>|<variable>|{ <expression> } {<statement list>}
<string>|<number>|<variable>|{ <expression> } {<statement list>}
...
default {<statement list>}
}
throw
Lève un objet en tant qu’erreur.
Syntaxe :
throw [<object>]
trap
Définit une liste d’instructions à exécuter si une erreur est rencontrée. Un type d’erreur nécessite des crochets. La deuxième paire de crochets indique que le type d’erreur est facultatif.
Syntaxe :
trap [[<error type>]] {<statement list>}
try
Définit une liste d’instructions à rechercher des erreurs pendant l’exécution des instructions. Si une erreur se produit, PowerShell continue de s’exécuter dans une catch
instruction ou finally
. Un type d’erreur nécessite des crochets. La deuxième paire de crochets indique que le type d’erreur est facultatif.
Syntaxe :
try {<statement list>}
catch [[<error type>]] {<statement list>}
finally {<statement list>}
until
Utilisé dans une do
instruction en tant que construction de boucle où la liste d’instructions est exécutée au moins une fois.
Syntaxe :
do {<statement list>} until (<condition>)
using
Vous permet d’indiquer quels espaces de noms sont utilisés dans la session. Les noms de types, les classes et les membres nécessitent moins de saisie pour les référencer. Vous pouvez également inclure des classes à partir de modules.
Syntaxe de l’espace de noms :
using namespace <.Net-namespace>
Syntaxe du module :
using module <module-name>
Syntaxe d’assembly :
using assembly <.NET-assembly-path>
Pour plus d’informations, consultez about_Using.
while
L’instruction while
est une construction de boucle où la condition est testée avant l’exécution des instructions. Si la condition est false, les instructions ne s’exécutent pas.
Syntaxe d’instruction :
while (<condition>) {
<statements>
}
En cas d’utilisation dans une do
instruction, while
fait partie d’une construction de boucle où la liste d’instructions est exécutée au moins une fois.
do
syntaxe de boucle :
do {<statement list>} while (<condition>)