Escolar Documentos
Profissional Documentos
Cultura Documentos
about_Functions_Advanced_Methods
DESCRIÇÃO RESUMIDA
Descreve como as funções que especificam o atributo CmdletBinding
podem usar os métodos e propriedades que estão disponíveis para
cmdlets compilados.
DESCRIÇÃO LONGA
As Funções que especificam o atributo CmdletBinding podem acessar
vários métodos e propriedades pela variável $ pscmdlet. Esses métodos
incluem:
Begin
Esse bloco é usado para fornecer um único pré-processamento
opcional para a função. O tempo de execução do Windows
PowerShell usa o código nesse bloco uma vez para cada instância
da função no pipeline.
Process
Esse bloco é usado para fornecer pré-processamento, registro
por registro, para a função. Esse bloco pode ser usado várias
vezes, ou não, dependendo da entrada para a função. Por
exemplo, se a função for o primeiro comando no pipeline,
o bloco Process será usado uma vez. Se a função não for o
primeiro comando no pipeline, o bloco Process será usado uma
vez para cada entrada que a função receber do pipeline. Se não
houver nenhuma entrada do pipeline, o bloco Process não será usado.
End
Esse bloco é usado para fornecer um único prós-processamento
opcional para a função.
Function Test-ScriptCmdlet
{
[CmdletBinding(SupportsShouldProcess=$True)]
Param ($Parameter1)
Begin{}
Process{}
End{}
}
Métodos de confirmação
ShouldProcess
Este método é chamado para solicitar confirmação do usuário
antes de a função executar uma ação que alteraria o sistema.
A função pode continuar baseada no valor Booleano retornado pelo
método. Esse método só pode ser chamado do bloco Process{} da
função. E o atributo CmdletBinding deve declarar que a função
dá suporte a ShouldProcess (como mostrado no exemplo anterior).
ShouldContinue
Esse método é chamado para solicitar uma segunda mensagem de
confirmação. Ele deve ser chamado quando o método ShouldProcess
retorna $true. Para obter mais informações sobre esse método,
consulte System.Management.Automation.Cmdlet.ShouldContinue na
biblioteca do MSDN em http://go.microsoft.com/fwlink/?LinkId=142143.
Métodos de erro
Métodos de gravação
WriteCommandDetail
Para obter mais informações sobre o método WriteCommandDetails,
consulte System.Management.Automation.Cmdlet.WriteCommandDetail na
biblioteca do MSDN em http://go.microsoft.com/fwlink/?LinkId=142155.
WriteDebug
Para fornecer informações que podem ser usadas para solucionar
problemas de uma função, faça a chamada de função do método
WriteDebug. Isso exibe mensagens de depuração ao usuário. Para
obter mais informações, consulte
System.Management.Automation.Cmdlet.WriteDebug na biblioteca do MSDN em
http://go.microsoft.com/fwlink/?LinkId=142156.
WriteError
As funções devem chamar esse método quando ocorrem erros
nonterminating e a função é criada para continuar processando
os registros. Para obter mais informações, consulte
System.Management.Automation.Cmdlet.WriteError na biblioteca do MSDN em
http://go.microsoft.com/fwlink/?LinkId=142157.
WriteObject
Esse método permite que a função envie um objeto ao próximo
comando no pipeline. Na maioria dos casos, esse é o método a
ser usado quando a função retorna dados. Para obter mais
informações, consulte
System.Management.Automation.PSCmdlet.WriteObject na biblioteca
do MSDN em http://go.microsoft.com/fwlink/?LinkId=142158.
WriteProgress
Para funções cujas ações levam muito tempo para serem
concluídas, esse método permite à função chamar o método
WriteProgress de forma que as informações de progresso sejam
exibidas. Por exemplo, você pode exibir a porcentagem
concluída. Para obter mais informações, consulte
System.Management.Automation.PSCmdlet.WriteProgress na
biblioteca do MSDN em http://go.microsoft.com/fwlink/?LinkId=142160.
WriteVerbose
Para fornecer informações detalhadas sobre o que a função está
fazendo, faça a chamada de função do método WriteVerbose para exibir
mensagens detalhadas ao usuário. Por padrão, não são exibidas mensagens
detalhadas. Para obter mais informações, consulte
System.Management.Automation.PSCmdlet.WriteVerbose na biblioteca do
MSDN em http://go.microsoft.com/fwlink/?LinkId=142162.
WriteWarning
Para fornecer informações sobre condições que podem causar
resultados inesperados, faça a chamada de função do método
WriteWarning para exibir mensagens de aviso ao usuário. Por
padrão, as mensagens de aviso são exibidas.
Para obter mais informações, consulte
System.Management.Automation.PSCmdlet.WriteWarning na
biblioteca do MSDN em http://go.microsoft.com/fwlink/?LinkId=142164.
CONSULTE TAMBÉM
about_Functions_Advanced
about_Functions_CmdletBindingAttributes
about_Functions_Advanced_Parameters