À propos des mots clés de langue
DESCRIPTION COURTE
Décrit les mots clés dans le langage de script PowerShell.
DESCRIPTION DÉTAILLÉE
PowerShell contient les mots clés de langage suivants. Pour plus d’informations, consultez la rubrique about pour le mot clé et les informations qui suivent le tableau.
Mots clés de langage
Début
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 seule fois avant la réception des objets du pipeline.
Syntaxe :
function <name> {
DynamicParam {<statement list>}
begin {<statement list>}
process {<statement list>}
end {<statement list>}
}
Arrêter
Provoque la fermeture d’une boucle par un script.
Syntaxe :
while (<condition>) {
<statements>
...
break
...
<statements>
}
Intercepter
Spécifie une liste d’instructions à exécuter si une erreur se produit dans la liste d’instructions Try associée. 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>}
Classe
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> ...]
}
Continuer
Provoque l’arrêt de l’exécution d’une boucle par un script et le retour à la condition. Si la condition est remplie, le script recommence la boucle.
Syntaxe :
while (<condition>) {
<statements>
...
continue
...
<statements>
}
Données
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>}
À faire
Utilisé avec ou While
Until
mot clé en tant que 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 du pipeline.
Syntaxe :
function <name> {
DynamicParam {<statement list>}
begin {<statement list>}
process {<statement list>}
end {<statement list>}
}
Énumération
enum
est utilisé pour déclarer une énumération ; un type distinct qui se compose d’un ensemble d’étiquettes nommées appelée liste d’énumérateurs.
Syntaxe :
enum <enum-name> {
<label> [= <int-value>]
...
}
Quitter
Provoque 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, tout nombre compris entre [int]::MinValue
et [int]::MaxValue
est autorisé.
Sur 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.
Filtrer
Spécifie une fonction dans laquelle la liste d’instructions s’exécute une fois pour chaque objet d’entrée. Elle a le même effet qu’une fonction qui contient uniquement un bloc Process.
Syntaxe :
filter <name> {<statement list>}
Finalement
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 quitter un script ou si vous utilisez l’mot clé Quitter dans le script.
Syntaxe :
try {<statement list>}
catch [<error type>] {<statement list>}
finally {<statement list>}
For
Définit une boucle à l’aide d’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> }
Du
Réservé pour un usage futur.
Fonction
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 d’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>}
}
Si
Définit une condition.
Syntaxe :
if (<condition>) {<statement list>}
Hidden
Masque les membres de classe des résultats par défaut de l’applet Get-Member
de commande et des résultats de saisie semi-automatique IntelliSense et tabulation.
Syntaxe :
Hidden [data type] $member_name
Dans
Utilisé dans une ForEach
instruction pour créer une boucle qui utilise chaque membre d’une collection.
Syntaxe :
ForEach (<item> in <collection>){<statement list>}
InlineScript
Exécute des commandes de flux de travail dans une session PowerShell partagée. Cette mot clé est valide uniquement dans un flux de travail PowerShell.
Syntaxe :
workflow <verb>-<noun>
{
InlineScript
{
<Command/Expression>
...
}
}
Le InlineScript
mot clé indique une InlineScript
activité, qui exécute des commandes dans une session standard partagée (sans flux de travail). Vous pouvez utiliser le InlineScript
mot clé pour exécuter des commandes qui ne sont pas autrement valides dans un flux de travail et pour exécuter des commandes qui partagent des données. Par défaut, les commandes d’un bloc de script InlineScript s’exécutent dans un processus distinct.
Pour plus d’informations, consultez Exécution de commandes PowerShell dans un flux de travail.
Paramètre
Définit les paramètres d’une fonction.
Syntaxe :
function [<scope:>]<name> {
param ([type]<$pname1>[, [[type]<$pname2>]])
<statement list>
}
Processus
Spécifie une partie du corps d’une fonction, ainsi que les DynamicParam
mots clés , Begin
et End
. Lorsqu’une Process
liste d’instructions 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>}
}
Renvoie
PowerShell quitte l’étendue actuelle, comme un script ou une fonction, et écrit l’expression facultative dans la sortie.
Syntaxe :
return [<expression>]
statique
Spécifie que la propriété ou la méthode définie est commune à toutes les instances de la classe dans laquelle est définie.
Consultez pour obtenir Class
des exemples d’utilisation.
Commutateur
Pour case activée plusieurs conditions, utilisez une Switch
instruction . L’instruction Switch
est équivalente à 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 en cas d’erreur. 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>}
Essai
Définit une liste d’instructions à rechercher 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>}
Jusqu’à
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>)
Utilisation
Permet d’indiquer quels espaces de noms sont utilisés dans la session. Les classes et les membres nécessitent moins de saisie pour les mention. Vous pouvez également inclure des classes de modules.
Syntaxe n°1 :
using namespace <.Net-framework-namespace>
Syntaxe n°2 :
using module <module-name>
While
L’instruction while
est une construction en 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>
}
Lorsqu’il est utilisé 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.
Syntaxe de boucle do :
do {<statement list>} while (<condition>)