cSeverityCharacterRequired
INFO, WARN, ERROR, FATAL or DEBUG.
FUNCTIONUnder review
FWLogMsg
FWLogMsg(cSeverity, [cTransactionId], cGroup, [cCategory], [cStep], [cMsgId], [cMessage], [nMensure], [nElapseTime], [aMessage])Records a structured Framework log message.
Overview
The API standardizes LogMsg with severity, group and correlation fields. Documented severities include INFO, WARN, ERROR, FATAL and DEBUG; debug requires FWLOGMSG_DEBUG configuration. With aMessage in console mode, cMessage is omitted to reduce overload. This example logs only an editorial message without user data, tokens or file contents. Logging is not a business commit. (Sources: refs. 1–1.)
Syntax
FWLogMsg(cSeverity, [cTransactionId], cGroup, [cCategory], [cStep], [cMsgId], [cMessage], [nMensure], [nElapseTime], [aMessage])Parameters
cTransactionIdCharacterOptional
Correlation ID; LAST reuses the previous one.
cGroupCharacterRequired
Message group.
cCategoryCharacterOptional
Message category.
cStepCharacterOptional
Processing step.
cMsgIdCharacterOptional
Message identifier.
cMessageCharacterOptional
Text message, documented 10K limit.
nMensureNumericOptional
Message measurement unit.
nElapseTimeNumericOptional
Elapsed time supplied by the routine.
aMessageArrayOptional
Extra key/value data; affects cMessage in console mode.
Return value
Formal return unspecified in the page; unused here.
Commented example
#Include "Protheus.ch"
User Function Ed435()
// Fictional message without secrets.
FWLogMsg("INFO",,"EDITORIAL",,,"ED435","Editorial review")
Return NilExpected result
Record follows LogServer/ConsoleLog configuration if executed. Under review: editorial example neither compiled nor run in Protheus. Check includes, release, RDD and context before testing.
- Check context and return before integration; the example does not replace a complete routine.
- Under review: editorial example neither compiled nor run in Protheus. Check includes, release, RDD and context before testing.
Comments
There are no approved comments yet.
Sign in with Google or Microsoft to comment.