Cancel

<< Clique para Mostrar o Sumário >>

 

Cancel

Cancel([ActorID])

Executa a ação de Cancel, em que o parâmetro ActorID é o nome do usuário. Se omitido, assume o logon do usuário do Elipse Water Viewer, "Anonymous" se não há usuário logado ou "System" se a chamada deste método foi originada no servidor. Caso haja uma ação Operate ou Select pendente, estas ações são canceladas e o evento OnOperateFinished ou OnSelectFinished é imediatamente disparado, executando o script associado e cancelando esta ocorrência. Para que esta ação ocorra, algumas condições são necessárias:

O Comando pai da Unidade deve ter a propriedade Enabled configurada para Verdadeiro

Não deve existir nenhum comando Cancel pendente na Unidade de Comando, ou seja, a propriedade ActionInProgress deve ser igual a 0 (zero, Nenhum), 1 (um, Operate) ou 2 (dois, Select)

O script de evento OnCancel deve estar definido no tipo de Conversão de comando configurado

 

Este comando espera pelo valor de retorno até o tempo limite especificado se todas as seguintes condições são atendidas:

O script foi executado com sucesso

O script não foi cancelado

O tempo limite de retorno da Conversão não é 0 (zero)

O caminho do Tag de retorno não é vazio

 

Caso o valor de retorno não seja utilizado pelo Tag dentro do tempo limite, ou se o caminho do Tag é inválido, mas não é vazio, este comando é considerado como falho.

 

NOTA

O valor de retorno só é considerado se a qualidade não é ruim. Se a ação funcionar ou mesmo falhar, o evento OnCancelFinished da Conversão configurada é executado, se foi definido.

Esta página foi útil?