ITOutputLogChannelCreateLogMsg

§ HLOGMSG ITLogChannelCreateLogMsg (HLOGCHANNEL hLogChannel, const char* pModuleStr, const char* pCaseStr);

§ HLOGMSG ITLogChannelCreateLogMsgEx (HLOGCHANNEL hLogChannel, const char* pModuleStr, const char* pCaseStr, int LogLevel);

Purpose:

§ create a logmessage object
This object is linked with the logchannel. It can be filled and then sent to the logchannel by calling its method ITLogMsgSend, for instance.

Parameters:

§ hLogChannel (Input): Handle to the logchannel, the logmessage will be sent to

§ pModuleString (Input): User defined specifier, describing a module or subsystem of the logging application.

§ pCaseString (Input): User defined specifier, describing a use-case or operation of the logging application.

§ LogLevel (Input): One or more Loglevel constants (for combinations use the ‘|’ operator)
(LEVEL_INFO, LEVEL_WARNING, LEVEL_ERROR, LEVEL_ALARM)

Return value:

§ If the logchannel is open and the Module and Case names pass the output filter condition defined for the logchannel in the configuration file, a handle to a new logmessage is returned.

§ Else (logchannel not open or logmessage filtered out) you get handle to a special null-logmessage object. With this can still use all normal ITLogMsg functions, but at the end not output will occur.