Início / Funções / Help

FUNÇÃO · INTERFACE

Help

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

Exibe uma ajuda contextual para o usuário, usando um código cadastrado no SIGAHLP ou uma mensagem informada diretamente pela rotina.

13PARÂMETROS

2MODOS DE USO

6LEGADOS

01 · COMO USAR

Ajuda contextual

A função pode recuperar um Help cadastrado pelo código do campo ou apresentar uma mensagem fornecida pela própria rotina. O array aSoluc permite sugerir ações ao usuário.

// Mensagem direta
Help(NIL, NIL, "VALIDA_FORM", NIL, ;
  "Preencha os campos obrigatórios.", ;
  1, 0, NIL, NIL, NIL, NIL, .T., ;
  {"Revise os campos destacados."})

02 · EXEMPLOS

Cenários comuns

Mensagem com solução

Texto direto, gravação de log e orientação ao usuário

ElseIf cIdPonto == "FORMPOS"
    Help(NIL, NIL, "Texto do Help", NIL, ;
        "Texto do Problema", 1, 0, NIL, ;
        NIL, NIL, NIL, NIL, ;
        {"Texto da Solução"})
    xRet := .F.
EndIf

Exemplo da fonte
Estrutura preservada a partir do HTML fornecido.

Help cadastrado

Consulta pelo código existente no SIGAHLP

// Exemplo ilustrativo
Help(NIL, NIL, "A1_COD", NIL, NIL, ;
    1, 0, NIL, NIL, NIL, NIL, .T., NIL)

Validação de formulário

Mensagem simples para interromper o fluxo

If Empty(cCodigo)
    Help(NIL, NIL, "COD_VAZIO", NIL, ;
        "Informe o código.", 1, 0, NIL, ;
        NIL, NIL, NIL, .T., ;
        {"Preencha o campo Código."})
    Return .F.
EndIf

03 · REFERÊNCIA

Parâmetros

cRotina

Mantido por compatibilidade. Não utilizar em novos códigos.

cRotina · Caracter

FINALIDADE

Mantido por compatibilidade. Não utilizar em novos códigos.

USO

Valor padrão	`NIL`
Categoria	Legado

Compatibilidade
Mantenha NIL em novos desenvolvimentos.

nLinha

Mantido por compatibilidade. Não utilizar em novos códigos.

nLinha · Numérico

FINALIDADE

Mantido por compatibilidade. Não utilizar em novos códigos.

USO

Valor padrão	`NIL`
Categoria	Legado

Compatibilidade
Mantenha NIL em novos desenvolvimentos.

cCampo

Código do Help cadastrado no SIGAHLP. Se não for informado, use cMensagem.

cCampo · Caracter

FINALIDADE

Código do Help cadastrado no SIGAHLP. Se não for informado, use cMensagem.

USO

Valor padrão	`NIL`
Categoria	Principal

cNome

Quando informado, substitui cCampo na identificação usada por cMensagem.

cNome · Caracter

FINALIDADE

Quando informado, substitui cCampo na identificação usada por cMensagem.

USO

Valor padrão	`NIL`
Categoria	Opcional

cMensagem

Mensagem apresentada quando o código de Help não é informado.

cMensagem · Caracter

FINALIDADE

Mensagem apresentada quando o código de Help não é informado.

USO

Valor padrão	`NIL`
Categoria	Principal

nLinha1

Linha inicial para apresentação da mensagem.

nLinha1 · Numérico

FINALIDADE

Linha inicial para apresentação da mensagem.

USO

Valor padrão	`1`
Categoria	Posição

nColuna

Coluna inicial para apresentação da mensagem.

nColuna · Numérico

FINALIDADE

Coluna inicial para apresentação da mensagem.

USO

Valor padrão	`0`
Categoria	Posição

lPop

Mantido por compatibilidade. Não utilizar em novos códigos.

lPop · Lógico

FINALIDADE

Mantido por compatibilidade. Não utilizar em novos códigos.

USO

Valor padrão	`NIL`
Categoria	Legado

Compatibilidade
Mantenha NIL em novos desenvolvimentos.

hWnd

Mantido por compatibilidade. Não utilizar em novos códigos.

hWnd · Objeto

FINALIDADE

Mantido por compatibilidade. Não utilizar em novos códigos.

USO

Valor padrão	`NIL`
Categoria	Legado

Compatibilidade
Mantenha NIL em novos desenvolvimentos.

nHeight

Mantido por compatibilidade. Não utilizar em novos códigos.

nHeight · Numérico

FINALIDADE

Mantido por compatibilidade. Não utilizar em novos códigos.

USO

Valor padrão	`NIL`
Categoria	Legado

Compatibilidade
Mantenha NIL em novos desenvolvimentos.

nWidth

Mantido por compatibilidade. Não utilizar em novos códigos.

nWidth · Numérico

FINALIDADE

Mantido por compatibilidade. Não utilizar em novos códigos.

USO

Valor padrão	`NIL`
Categoria	Legado

Compatibilidade
Mantenha NIL em novos desenvolvimentos.

lGravaLog

Indica se a mensagem de Help deve ser gravada em log.

lGravaLog · Lógico

FINALIDADE

Indica se a mensagem de Help deve ser gravada em log.

USO

Valor padrão	`NIL`
Categoria	Opcional

aSoluc

Array simples com uma ou mais mensagens de solução para o Help.

aSoluc · Array

FINALIDADE

Array simples com uma ou mais mensagens de solução para o Help.

USO

Valor padrão	`NIL`
Categoria	Opcional

Conteúdo estruturado a partir do HTML TDN fornecido. Exemplos ilustrativos devem ser validados no ambiente Protheus.