TÓPICO
about_Requires
DESCRIÇÃO RESUMIDA
Impede a execução de um script ao requerer os snap-ins e a versão
especificados.
DESCRIÇÃO LONGA
A instrução #Requires impede a execução de um script, a menos que
os pré-requisitos de versão do Windows PowerShell, snap-in e versão
do snap-in sejam atendidos. Se os pré-requisitos não forem atendidos,
o Windows PowerShell não executará o script.
Você pode usar instruções #Requires em qualquer script. Não é possível
usá-las em funções, cmdlets ou snap-ins.
Sintaxe
Use a seguinte sintaxe para especificar o snap-in e a versão do
snap-in que você deseja requerer:
#requires -PsSnapIn <PsSnapIn> [-Version <N>[.<n>]]
Use a seguinte sintaxe para especificar a versão mínima do Windows
PowerShell que você deseja requerer:
#requires -Version <N>[.<n>]
Use a seguinte sintaxe para especificar o shell que você deseja
requerer:
#requires -ShellId <ShellId>
Regras de uso
- A instrução #Requires deve ser o primeiro item em uma linha
de um script.
- Um script pode incluir mais de uma instrução #Requires.
- As instruções #Requires podem aparecer em qualquer linha de
um script.
Exemplos
A instrução a seguir requer o snap-in Microsoft.PowerShell.Security:
#requires -PsSnapIn Microsoft.PowerShell.Security
Se o snap-in Microsoft.PowerShell.Security não for carregado,
o script não será executado e o Windows PowerShell exibirá a seguinte
mensagem de erro:
"O script '<nome-do-script>' não pode ser executado porque os
seguintes snap-ins do Windows PowerShell especificados por suas
instruções "#requires" estão ausentes: Microsoft.PowerShell.Security."
A instrução a seguir requer a versão do Windows PowerShell 2.0
ou qualquer versão posterior do snap-in Microsoft.PowerShell.Security:
#requires -PsSnapIn Microsoft.PowerShell.Security -Version 2
A instrução a seguir requer o Windows PowerShell 2.0 ou uma versão
posterior:
#requires -Version 2.0
O script a seguir tem duas instruções #Requires. Os requisitos
especificados nas duas instruções devem ser atendidos. Caso
contrário, o script não será executado. Cada instrução #Requires
deve ser o primeiro item em uma linha:
#requires -PsSnapIn Microsoft.PowerShell.Security -Version 2
Get-WMIObject WIN32_LogicalDisk | out-file K:\status\DiskStatus.txt
#requires -Version 2
A instrução #Requires a seguir impedirá que um script seja
executado se a ID de shell especificada não corresponder à ID
de shell atual. A ID de shell atual é armazenada na variável
$ShellId:
#requires -ShellId MyLocalShell
CONSULTE TAMBÉM
about_Automatic_Variables
about_Language_Keywords
about_PSSnapins
get-PSSnapin