ITLogMsg::AddParam

 

bool AddParam(const char* szParamName, const char Value,

bool bCopyValueToMsgText= false, bool bCopyParamNameToMsgText= false);

bool AddParam(const char* szParamName, const char* Value,

bool bCopyValueToMsgText= false, bool bCopyParamNameToMsgText= false);

bool AddParam(const char* szParamName, const int& Value,

bool bCopyValueToMsgText= false, bool bCopyParamNameToMsgText= false);

bool AddParam(const char* szParamName, const double& Value,

bool bCopyValueToMsgText= false, bool bCopyParamNameToMsgText= false);

bool AddParam(const char* szParamName, const float& Value,

bool bCopyValueToMsgText= false, bool bCopyParamNameToMsgText= false);

 

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:

§      szParamName: parameter name

§      Value: parameter value

§      bCopyValueToMsgText: If set, then the value will additionally be appended to the logmessage text.

§      bCopyParamNameToMsgText: Indicates if 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 true