ITLogMsgAddParam

 

int ITLogMsgAddParamChar   (HLOGMSG hLogMsg, const char* pParamName, const char Value);

int ITLogMsgAddParamCharEx (HLOGMSG hLogMsg, const char* pParamName, const char Value,
int bCopyValueToMsgText, int bCopyParamNameToMsgText);

 

int ITLogMsgAddParamStr (HLOGMSG hLogMsg, const char* pParamName, const char* Value);

int ITLogMsgAddParamStrEx (HLOGMSG hLogMsg, const char* pParamName, const char* Value, int bCopyValueToMsgText, int bCopyParamNameToMsgText);

 

int ITLogMsgAddParamInt (HLOGMSG hLogMsg, const char* pParamName, const int Value);

int ITLogMsgAddParamIntEx (HLOGMSG hLogMsg, const char* pParamName, const int Value, int bCopyValueToMsgText, int bCopyParamNameToMsgText);

 

int ITLogMsgAddParamDbl (HLOGMSG hLogMsg, const char* pParamName, const double Value);

int ITLogMsgAddParamDblEx (HLOGMSG hLogMsg, const char* pParamName, const double Value, int bCopyValueToMsgText, int bCopyParamNameToMsgText);

 

int ITLogMsgAddParamFloat (HLOGMSG hLogMsg, const char* pParamName, const float Value);

int ITLogMsgAddParamFloatEx (HLOGMSG hLogMsg, const char* pParamName, const float Value, int bCopyValueToMsgText, int bCopyParamNameToMsgText);

 

Purpose:

§      add a named parameter including its value to the logmessage.
For more about parameters, read the topic
About user-defined parameters in logmessages.

Parameters:

§      hLogMsg (Input): Handle to a logmessage

§      pParamName (Input): parameter name

§      Value: parameter value

§      bCopyValueToMsgText (Input): If set (not 0), the value will additionally be appended to the logmessage text.

§      bCopyParamNameToMsgText (Input): If set (not 0), the parameter name will additionally be appended to the logmessage text. If both options flags are set, the appendings will be made in the following form: ParmName=Value In all cases, no spaces or whitespace will be added to the logmessage text.

 

Return value:

§      currently always 1