RUBRIQUE
about_Requires
DESCRIPTION COURTE
Empêche l'exécution d'un script en requérant la version et les
composants logiciels enfichables spécifiés.
DESCRIPTION LONGUE
L'instruction #Requires empêche l'exécution d'un script si les
conditions préalables liées à la version de Windows PowerShell,
au composant logiciel enfichable et à la version de ce composant
ne sont pas remplies. Si les conditions préalables ne sont pas
remplies, Windows PowerShell n'exécute pas le script.
Vous pouvez utiliser les instructions #Requires dans n'importe
quel script. Vous ne pouvez pas les utiliser dans les fonctions,
applets de commande ni composants logiciels enfichables.
Syntaxe
Utilisez la syntaxe suivante pour spécifier le composant logiciel
enfichable et la version du composant logiciel enfichable que vous
souhaitez requérir :
#requires -PsSnapIn <PsSnapIn> [-Version <N>[.<n>]]
Utilisez la syntaxe suivante pour spécifier la version minimale
de Windows PowerShell que vous souhaitez requérir :
#requires -Version <N>[.<n>]
Utilisez la syntaxe suivante pour spécifier l'interpréteur de
commandes que vous souhaitez requérir :
#requires -ShellId <ShellId>
Règles d'utilisation
- L'instruction #Requires doit être le premier élément sur une
ligne d'un script.
- Un script peut inclure plusieurs instructions #Requires.
- Les instructions #Requires peuvent apparaître sur n'importe
quelle ligne d'un script.
Exemples
L'instruction suivante requiert le composant logiciel enfichable
Microsoft.PowerShell.Security :
#requires -PsSnapIn Microsoft.PowerShell.Security
Si le composant logiciel enfichable Microsoft.PowerShell.Securit
y n'est pas chargé, le script ne s'exécute pas et Windows PowerShell
affiche le message d'erreur suivant :
" Le script <nom-script> ne peut pas être exécuté, car les
composants logiciels enfichables Windows PowerShell suivants,
spécifiés par les instructions #requires du script, sont absents :
Microsoft.PowerShell.Security ".
L'instruction suivante requiert Windows PowerShell version 2.0
ou toute version ultérieure du composant logiciel enfichable
Microsoft.PowerShell.Security :
#requires -PsSnapIn Microsoft.PowerShell.Security -Version 2
L'instruction suivante requiert Windows PowerShell 2.0 ou une
version ultérieure :
#requires -Version 2.0
Le script suivant a deux instructions #Requires. Les conditions
spécifiées dans les deux instructions doivent être remplies.
Sinon, le script ne s'exécutera pas. Chaque instruction
#Requires doit être le premier élément sur une ligne :
#requires -PsSnapIn Microsoft.PowerShell.Security -Version 2
Get-WMIObject WIN32_LogicalDisk | out-file K:\status\DiskStatus.txt
#requires -Version 2
L'instruction #Requires suivante empêche l'exécution d'un script si
l'ID de l'interpréteur de commandes spécifié ne correspond pas à
l'ID de l'interpréteur de commandes actuel. L'ID de l'interpréteur
de commandes actuel est stocké dans la variable $ShellId :
#requires -ShellId MyLocalShell
VOIR AUSSI
about_Automatic_Variables
about_Language_Keywords
about_PSSnapins
get-PSSnapin