Função: Help - Ajuda para o campo
| Abrangências: | Microsiga Protheus 11 , Protheus 10 |
| Compatível Países: | Todos |
| Sistemas Operacionais: | Todos |
| Compatível às Bases de Dados: | Todos |
| Nível de Acesso: | Nível 1 (Acesso Clientes) |
Descrição:
A função Help exibe a ajuda especificada para o campo e permite sua edição. Se for um help novo, o texto informado é apresentado em tempo de execução.
Programa Fonte:
SIGAHLP.PRW
Sintaxe:
Help - Ajuda para o campo ( [ uPar1 ] [ uPar2 ] [ cCampo ] [ cNome ] [ cMensagem ] [ nLinha1 ] [ nColuna ] [ lPop ] [ uPar9 ] [ uPar10 ] [ uPar11 ] [ lGravaLog ] )
Retorno:
-
()
Observações
A função Help() é tratada na execução das rotinas com o recurso de MSExecAuto(), permitindo a captura e exibição da mensagem no log de processamento.
Por esta razão, em rotinas que podem ser chamadas através da função MSExecAuto() deve-se sempre utilizar avisos utilizando esta função, para que este tipo de processamento não seja travado indevidamente.
Por esta razão, em rotinas que podem ser chamadas através da função MSExecAuto() deve-se sempre utilizar avisos utilizando esta função, para que este tipo de processamento não seja travado indevidamente.
Exemplos
Help('',1,'DATAFIN',,'Não é possível inserir títulos se a data base for anterior a data do parâmetro XXX',1,0) Help(" ",1,"NUMSEQ",,"XXX",4,15)
Parâmetros:
| Nome | Tipo | Descrição | Default | Obrigatório | Referência | ||||||||||||
| uPar1 | Qualquer | Parâmetro não utilizado. | |||||||||||||||
| uPar2 | Qualquer | Parâmetro não utilizado. | |||||||||||||||
| cCampo | Caracter | Título do campo. | |||||||||||||||
| cNome | Caracter | Nome do help. | |||||||||||||||
| cMensagem | Caracter | Mensagem a ser exibida no help. | |||||||||||||||
| nLinha1 | Numérico | Número de linhas da mensagem. (relativa à janela). | |||||||||||||||
| nColuna | Numérico | Número de linhas da mensagem. (relativa à janela). | |||||||||||||||
| lPop | Lógico | Apresenta a janela. | .F. | ||||||||||||||
| uPar9 | Qualquer | Parâmetro não utilizado. | |||||||||||||||
| uPar10 | Qualquer | Parâmetro não utilizado. | |||||||||||||||
| uPar11 | Qualquer | Parâmetro não utilizado. | |||||||||||||||
| lGravaLog | Lógico | Se .T. as informações apresentadas no Help serão gravadas no arquivo de log. | .T. |