Sintaxe
AxDeleta( <cAlias>, <nReg>, <nOpc>, <cTransact>, <aCpos>, <aButtons>, <aParam>, <aAuto>, <lMaximized>)
Propósito
Permite, por meio de uma interface, que o usuário altere as informações de um arquivo de dados, conforme a necessidade da aplicação.
Argumentos
< cAlias >
Arquivo de dados cujas informações serão excluídas. Esse arquivo está cadastrado no Dicionário de Tabelas do Protheus (SX2).
< nReg >
Número do registro (recno) posicionado no alias ativo e que será excluído.
< nOpc >
Número da linha do array aRotina que define o tipo de edição (Inclusão, Alteração, Exclusão e Visualização). A função AxDeleta() será executada quando o usuário selecionar a opção Exclusão.
< cTransact >
Função que será executada dentro da transação da AxFunction().
< aCpos >
Array com o nome dos campos que aparecerão na tela.
< aButtons >
Botões adicionais que serão adicionados na barra de ferramentas padrão (EnchoiceBar). As informações de cada botão devem ser passadas no seguinte formato:
aArray[n][1] --> Imagem do botão
aArray[n][2] --> Bloco de código contendo a ação que o botão executará
aArray[n][3] --> Título do botão
< aParam >
Funções que serão executadas em pontos pré-definidos da AxFunction(), conforme descrito abaixo:
aParam[1] --> Bloco de código que será processado antes da exibição das informações na tela
aParam[2] --> Bloco de código para processamento na validação da confirmação da exclusão
aParam[3] --> Bloco de código que será executado dentro da transação da AxFunction()
aParam[4] --> Bloco de código que será executado fora da transação da AxFunction()
< aAuto >
Indica que a alteração será realizada de forma automática pela própria função, sem a necessidade de exibir a tela de interface e com base nos dados enviados neste parâmetro.
Esse array é montado no formato utilizado pela função padrão MsExecAuto(). Caso esse array seja informado, a tela de interface não será exibida e será executada a função EnchAuto().
O array deve ser montado no seguinte formato:
aAuto[n][1] --> Nome do campo
aAuto[n][2] --> Conteúdo do campo
aAuto[n][3] --> Validação que será utilizada em substituição às validações definidas no Dicionário de dados SX3
< lMaximized >
Indica se a janela será maximizada ou não.
Deve-se informar verdadeiro (.T.) para se maximizar a janela ou falso (.F.) para não maximizá-la.
Utilização
Esse componente visual é muito utilizado na interface das aplicações para excluir informações existentes nos arquivos de dados.
Observação
Essa função pertence ao framework do ERP Protheus.
Exemplos
USER FUNCTION CTJ40Exc()
LOCAL nReg := ( cString )->( Recno() )
AxDeleta(cString, nReg, 5)
RETURN NIL