Usina BRAdvPL Guia
Entrar
← Todos os tópicos
FUNçãOEm revisão

Help

Help(cRotina,nLinha,cCampo,cNome,cMensagem,nLinha1,nColuna,lPop,hWnd,nHeight,nWidth,lGravaLog,aSoluc)

Apresenta uma mensagem de problema com orientação de solução.

HelpAdvPL
01 · VISÃO GERAL

Visão geral

A assinatura contém parâmetros mantidos por compatibilidade, identificados como não utilizáveis na documentação. cCampo aponta código do help; sem esse código, cMensagem fornece o texto e aSoluc contém linhas de solução. O exemplo usa mensagem direta sem código, em uma sessão com interface; não presume retorno lógico para validação. (Fontes: refs. 1–1.)

02 · SINTAXE

Sintaxe

Help(cRotina,nLinha,cCampo,cNome,cMensagem,nLinha1,nColuna,lPop,hWnd,nHeight,nWidth,lGravaLog,aSoluc)

Parâmetros

cRotina
CaractereOpcional

Compatibilidade: manter NIL.

nLinha
NuméricoOpcional

Compatibilidade: manter NIL.

cCampo
CaractereOpcional

Código do help; sem código, fornecer cMensagem.

cNome
CaractereOpcional

Substitui cCampo quando informado.

cMensagem
CaractereOpcional

Texto direto quando não há código.

nLinha1
NuméricoOpcional

Linha inicial da mensagem.

nColuna
NuméricoOpcional

Coluna inicial da mensagem.

lPop
LógicoOpcional

Compatibilidade: manter NIL.

hWnd
ObjetoOpcional

Compatibilidade: manter NIL.

nHeight
NuméricoOpcional

Compatibilidade: manter NIL.

nWidth
NuméricoOpcional

Compatibilidade: manter NIL.

lGravaLog
LógicoOpcional

Controla gravação de log da mensagem.

aSoluc
ArrayOpcional

Linhas de orientação para solução.

Retorno

A página consultada não especifica um retorno utilizável como validação. O chamador controla o fluxo explicitamente.

03 · EXEMPLO PRÁTICO

Exemplo comentado

#Include "Protheus.ch"

User Function Ed481()
    // Executar apenas em sessao interativa de teste.
    Help(Nil,Nil,Nil,Nil,"Informe um codigo valido.",1,0,Nil,Nil,Nil,Nil,Nil,{"Revise o campo antes de continuar."})
Return Nil
Resultado esperado

Apresenta orientação; bloquear ou permitir a operação exige lógica explícita do chamador. Em revisão: exemplo editorial não compilado nem executado em Protheus. Conferir includes, release, RDD e contexto antes de homologar.

BOAS PRÁTICAS
  • Redigir problema e solução acionável. Não exibir credenciais ou dados de clientes na mensagem.
  • Em revisão: exemplo editorial não compilado nem executado em Protheus. Conferir includes, release, RDD e contexto antes de homologar.

Conteúdos relacionados

REFERÊNCIAS
  1. TOTVS. Help. TDN. Consulta em 2026-10-27.
Situação
Em revisão
Página criada em
Última revisão em
Idioma original
Português
Revisão
Usina.BR
0 comentário(s) aprovado(s)

Comentários

Ainda não há comentários aprovados.

Entre com Google ou Microsoft para comentar.

Powered by Usina Docs · Alpha