Adds a named parameter including its value to the logmessage. See the Remarks section below.

AddParam is overloaded for several basic parameter value types (string, character, integer, float (single) and double) and has two option parameters (flags).

Its general form is:

AddParam(string ParameterName, type ParameterValue [, bool CopyValueToMsgText] [, bool CopyParamNameToMsgText]);

Overload List

Adds a named Double parameter including its value to the logmessage, leaving the Text property of the ITLogMsg object unchanged.

[Visual Basic] Overloads Public Function AddParam(String,Double) As Boolean

[C#] public bool AddParam(string,double);

[JScript] public function AddParam(String,double) : boolean

Adds a named Double parameter including its value to the logmessage and also appends the parameter value to the Text property of the ITLogMsg object, if you set the CopyValueToMsgText flag.

[Visual Basic] Overloads Public Function AddParam(String,Double,Boolean) As Boolean

[C#] public bool AddParam(string,double,bool);

[JScript] public function AddParam(String,double,boolean) : boolean

Adds a named Double parameter including its value to the logmessage and also appends the parameter name and value to the Text property of the ITLogMsg object, depending on the values you give in the CopyValueToMsgText and CopyParamNameToMsgText flags.

[Visual Basic] Overloads Public Function AddParam(String,Double,Boolean,Boolean) As Boolean

[C#] public bool AddParam(string,double,bool,bool);

[JScript] public function AddParam(String,double,boolean,boolean) : boolean

Adds a named integer parameter including its value to the logmessage, leaving the Text property of the ITLogMsg object unchanged.

[Visual Basic] Overloads Public Function AddParam(String,Integer) As Boolean

[C#] public bool AddParam(string,int);

[JScript] public function AddParam(String,int) : boolean

Adds a named integer parameter including its value to the logmessage and also appends the parameter value to the Text property of the ITLogMsg object, if you set the CopyValueToMsgText flag.

[Visual Basic] Overloads Public Function AddParam(String,Integer,Boolean) As Boolean

[C#] public bool AddParam(string,int,bool);

[JScript] public function AddParam(String,int,boolean) : boolean

Adds a named integer parameter including its value to the logmessage and also appends the parameter name and value to the Text property of the ITLogMsg object, depending on the values you give in the CopyValueToMsgText and CopyParamNameToMsgText flags.

[Visual Basic] Overloads Public Function AddParam(String,Integer,Boolean,Boolean) As Boolean

[C#] public bool AddParam(string,int,bool,bool);

[JScript] public function AddParam(String,int,boolean,boolean) : boolean

Adds a named character parameter including its value to the logmessage, leaving the Text property of the ITLogMsg object unchanged.

[Visual Basic] Overloads Public Function AddParam(String,SByte) As Boolean

[C#] public bool AddParam(string,sbyte);

[JScript] public function AddParam(String,sbyte) : boolean

Adds a named character parameter including its value to the logmessage and also appends the parameter value to the Text property of the ITLogMsg object, if you set the CopyValueToMsgText flag.

[Visual Basic] Overloads Public Function AddParam(String,SByte,Boolean) As Boolean

[C#] public bool AddParam(string,sbyte,bool);

[JScript] public function AddParam(String,sbyte,boolean) : boolean

Adds a named character parameter including its value to the logmessage and also appends the parameter name and value to the Text property of the ITLogMsg object, depending on the values you give in the CopyValueToMsgText and CopyParamNameToMsgText flags.

[Visual Basic] Overloads Public Function AddParam(String,SByte,Boolean,Boolean) As Boolean

[C#] public bool AddParam(string,sbyte,bool,bool);

[JScript] public function AddParam(String,sbyte,boolean,boolean) : boolean

Adds a named Single parameter including its value to the logmessage, leaving the Text property of the ITLogMsg object unchanged.

[Visual Basic] Overloads Public Function AddParam(String,Single) As Boolean

[C#] public bool AddParam(string,float);

[JScript] public function AddParam(String,float) : boolean

Adds a named Single parameter including its value to the logmessage and also appends the parameter value to the Text property of the ITLogMsg object, if you set the CopyValueToMsgText flag.

[Visual Basic] Overloads Public Function AddParam(String,Single,Boolean) As Boolean

[C#] public bool AddParam(string,float,bool);

[JScript] public function AddParam(String,float,boolean) : boolean

Adds a named Single parameter including its value to the logmessage and also appends the parameter name and value to the Text property of the ITLogMsg object, depending on the values you give in the CopyValueToMsgText and CopyParamNameToMsgText flags.

[Visual Basic] Overloads Public Function AddParam(String,Single,Boolean,Boolean) As Boolean

[C#] public bool AddParam(string,float,bool,bool);

[JScript] public function AddParam(String,float,boolean,boolean) : boolean

Adds a named string parameter including its value to the logmessage, leaving the Text property of the ITLogMsg object unchanged.

[Visual Basic] Overloads Public Function AddParam(String,String) As Boolean

[C#] public bool AddParam(string,string);

[JScript] public function AddParam(String,String) : boolean

Adds a named string parameter including its value to the logmessage and also appends the parameter value to the Text property of the ITLogMsg object, if you set the CopyValueToMsgText flag.

[Visual Basic] Overloads Public Function AddParam(String,String,Boolean) As Boolean

[C#] public bool AddParam(string,string,bool);

[JScript] public function AddParam(String,String,boolean) : boolean

Adds a named string parameter including its value to the logmessage and also appends the parameter name and value to the Text property of the ITLogMsg object, depending on the values you give in the CopyValueToMsgText and CopyParamNameToMsgText flags.

[Visual Basic] Overloads Public Function AddParam(String,String,Boolean,Boolean) As Boolean

[C#] public bool AddParam(string,string,bool,bool);

[JScript] public function AddParam(String,String,boolean,boolean) : boolean

Remarks

About user-defined parameters in logmessages

Basically all the parameters you add using the ITLogMsg.AddParam methods are stored as an attribute of the logmessage, like its timestamp, Loglevel, Text and so on, but freely defined by you. You are even free to use a name like "LogLevel" for a parameter, since the parameters use a namespace of their own.

Depending on the values of the (optional) option flags in the call to AddParam, the parameter is not necessarily seen in the logmessage text. The latter is just another, different attribute of the logmessage.

Future support of parameters

In a future version ITLogBook will be enabled to evaluate the parameters of the logmessages, so that you can display them in extra columns and use them in your filters definitions.

Current support for parameters

Already today the use of AddParam is strongly recommended, since this will enable you to make use of the described ITLogBook features in the future without reworking your programs then. Recompiling and relinking should suffice in that case.

The current version (version 2) of iTech Logging supports parameters like follows:

The option flags bCopyValueToMsgText and bCopyParamNameToMsgText are fully implemented.
The parameters are not really stored in the logfile. Instead they are added (dumped) in a human-readably format at the end of the text of logmessage they belong to, so you can inspect the values from within ITLogBook.
You can even define filters in ITLogBook that make use of that dump (using string-search filters -- named Custom filters -- in ITLogBook). But be aware that the dump will be probably removed when parameters are fully implemented! (OK, we might include an option to enable it again, if you wish).

See Also

Language

AddParam Method