Page tree
Skip to end of metadata
Go to start of metadata

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.
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:
NomeTipoDescriçãoDefaultObrigatórioReferência
uPar1QualquerParâmetro não utilizado.
uPar2QualquerParâmetro não utilizado.
cCampoCaracterTítulo do campo.
cNomeCaracterNome do help.
cMensagemCaracterMensagem a ser exibida no help.
nLinha1NuméricoNúmero de linhas da mensagem. (relativa à janela).
nColunaNuméricoNúmero de linhas da mensagem. (relativa à janela).
lPopLógicoApresenta a janela..F.
uPar9QualquerParâmetro não utilizado.
uPar10QualquerParâmetro não utilizado.
uPar11QualquerParâmetro não utilizado.
lGravaLogLógicoSe .T. as informações apresentadas no Help serão gravadas no arquivo de log..T.

  • No labels