TEMA
about_Requires
DESCRIPCIÓN BREVE
Impide la ejecución de un script requiriendo los complementos y
la versión especificados.
DESCRIPCIÓN DETALLADA
La instrucción #Requires impide que se ejecute un script, a menos
que se cumplan los requisitos previos referentes a la versión de
Windows PowerShell, el complemento y la versión del complemento.
Si no se cumplen los requisitos previos, Windows PowerShell no
ejecuta el script.
Las instrucciones #Requires se pueden usar en cualquier script.
No se pueden usar en funciones, cmdlets o complementos.
Sintaxis
Utilice la sintaxis siguiente para especificar el complemento y
la versión de complemento que desea requerir:
#requires -PsSnapIn <complemento de PowerShell> [-Version <N>[.<n>]]
Utilice la sintaxis siguiente para especificar la versión mínima de
Windows PowerShell que desea requerir:
#requires -Version <N>[.<n>]
Utilice la sintaxis siguiente para especificar el shell que desea requerir:
#requires -ShellId <identificador de shell>
Reglas de uso
- La instrucción #Requires debe ser el primer elemento de una
línea en un script.
- Un script puede incluir varias instrucciones #Requires.
- Las instrucciones #Requires pueden aparecer en cualquier
línea de un script.
Ejemplos
La instrucción siguiente requiere el complemento
Microsoft.PowerShell.Security:
#requires -PsSnapIn Microsoft.PowerShell.Security
Si no se carga el complemento Microsoft.PowerShell.Security, el
script no se ejecuta y Windows PowerShell muestra el siguiente
mensaje de error:
"No se puede ejecutar el script '<nombre del script>' porque faltan
los siguientes complementos que están especificados por las
instrucciones "#requires" del script: Microsoft.PowerShell.Security."
La instrucción siguiente requiere la versión Windows PowerShell
2.0 o cualquier versión posterior del complemento
Microsoft.PowerShell.Security:
#requires -PsSnapIn Microsoft.PowerShell.Security -Version 2
La instrucción siguiente requiere Windows PowerShell 2.0 o una
versión posterior:
#requires -Version 2.0
El siguiente script tiene dos instrucciones #Requires. Se deben
cumplir los requisitos especificados en ambas instrucciones. De lo
contrario, el script no se ejecutará. Cada instrucción #Requires debe
ser el primer elemento de una línea:
#requires -PsSnapIn Microsoft.PowerShell.Security -Version 2
Get-WMIObject WIN32_LogicalDisk | out-file K:\status\DiskStatus.txt
#requires -Version 2
La siguiente instrucción #Requires impide la ejecución de un
script si el identificador de shell especificado no coincide con el
identificador de shell actual. El identificador de shell actual está
almacenado en la variable $ShellId:
#requires -ShellId MyLocalShell
VEA TAMBIÉN
about_Automatic_Variables
about_Language_Keywords
about_PSSnapins
get-PSSnapin