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

FWLogMsg

FWLogMsg(cSeverity, [cTransactionId], cGroup, [cCategory], [cStep], [cMsgId], [cMessage], [nMensure], [nElapseTime], [aMessage])

Registra mensagem estruturada no log do Framework.

FWLogMsgAdvPL
01 · VISÃO GERAL

Visão geral

A API padroniza a implementação LogMsg com severidade, grupo e campos de correlação. As severidades documentadas incluem INFO, WARN, ERROR, FATAL e DEBUG; debug depende da configuração FWLOGMSG_DEBUG. Quando aMessage é fornecido no modo console, cMessage é omitido para evitar sobrecarga. O exemplo registra apenas uma mensagem editorial sem dados de usuário, tokens ou conteúdo de arquivos. Não confundir gravação de log com commit de negócio. (Fontes: refs. 1–1.)

02 · SINTAXE

Sintaxe

FWLogMsg(cSeverity, [cTransactionId], cGroup, [cCategory], [cStep], [cMsgId], [cMessage], [nMensure], [nElapseTime], [aMessage])

Parâmetros

cSeverity
CaractereObrigatório

INFO, WARN, ERROR, FATAL ou DEBUG.

cTransactionId
CaractereOpcional

Identificador de correlação; LAST reutiliza o anterior.

cGroup
CaractereObrigatório

Grupo da mensagem.

cCategory
CaractereOpcional

Categoria da mensagem.

cStep
CaractereOpcional

Etapa de processamento.

cMsgId
CaractereOpcional

Identificador da mensagem.

cMessage
CaractereOpcional

Mensagem textual, limite documentado de 10K.

nMensure
NuméricoOpcional

Unidade de medida da mensagem.

nElapseTime
NuméricoOpcional

Tempo decorrido informado pela rotina.

aMessage
ArrayOpcional

Dados adicionais como pares chave/valor; afeta cMessage no console.

Retorno

Retorno formal não especificado na ficha; não usado.

03 · EXEMPLO PRÁTICO

Exemplo comentado

#Include "Protheus.ch"

User Function Ed435()
    // Mensagem ficticia sem segredos.
    FWLogMsg("INFO",,"EDITORIAL",,,"ED435","Revisao editorial")
Return Nil
Resultado esperado

Registro conforme configuração do LogServer/ConsoleLog, se executado. Em revisão: exemplo editorial não compilado nem executado em Protheus. Conferir includes, release, RDD e contexto antes de homologar.

BOAS PRÁTICAS
  • Conferir o contexto e o retorno antes de integrar; o exemplo não substitui a rotina completa.
  • 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. FWLogMsg. 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