AddParam(String,String,Boolean,Boolean) Method

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( _
   ByVal Name As String, _
   ByVal Value As String, _
   ByVal CopyValueToMsgText As Boolean, _
   ByVal CopyParamNameToMsgText As Boolean _
) As Boolean

[C#]
public bool AddParam( 
   string Name,
   string Value,
   bool CopyValueToMsgText,
   bool CopyParamNameToMsgText
);

[JScript]
public function AddParam( 
   Name : String,
   Value : String,
   CopyValueToMsgText : boolean,
   CopyParamNameToMsgText : boolean
) : boolean;

Parameters

Name

The name of the parameter.

Value

The value of the parameter.

CopyValueToMsgText

Indicates if the parameter value should additionally be appended to the logmessage text.

CopyParamNameToMsgText

Indicates if the parameter name should additionally be appended to the logmessage text.

Remarks

When you set both option flags, the text appended to ITLogMsg.Text will have the following form:

ParamName=ParamValue

 

See Also

ITLogMsg Class  | ITLogMsg Members  | Overload List  | ITLogMsg.AddParam Overview

(c) 2002-2004 iTech Software GmbH, Berlin. Version 2.4, Wed 07 Jul 2004.