Share via

ContentList.TraceMessages Property (PIA)

  • Article

The TraceMessages property is a SimpleList object that contains the list of trace strings that have accumulated for the given item in a ContentList object. The TraceMessages property is read-only; however, the returned SimpleList object is read/write.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Caching
Imports Microsoft.CommerceServer.Interop     ‘ for ISimpleList
…
Public ReadOnly Property TraceMessages(RowNum As Integer) As ISimpleList

[C#]

using Microsoft.CommerceServer.Interop.Caching;
…
ISimpleList get_TraceMessages(intRowNum);

Parameters

[Visual Basic .NET]

  • RowNum
    An Integer that contains the position of the row for which the trace messages will be returned. Row positions start at zero (0), not one (1).

[C#]

  • RowNum
    A int that contains the position of the row for which the trace messages will be returned. Row positions start at zero (0), not one (1).

Return Values

[C#]

This method returns the ISimpleList interface of the SimpleList object that contains the trace messages.

The get_TraceMessages method cannot be viewed in IntelliSense.

Exceptions

This property may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

Remarks

The TraceMode property acts as a global switch to control whether any score tracing is performed. If it is set to True, score tracing is performed. If it is set to False, score tracing is suppressed.

When you use score tracing, you will notice a dramatic negative effect on performance; score tracing should not be used under normal circumstances. However, it can be useful when you are attempting to troubleshoot a scoring-related issue.

The list will be empty if the TraceMode property is set to False or if no score modifications have been made to the item.

Each item in the list is a string in the following format:

<component>,<operator><number>,<description>

Where the fields of the string are defined as follows:

  • component
    The identifier of the component that made the score change, as passed to the AdjustScore, SetScore, and Filter methods.
  • operator
    = if the score set to an absolute value by the SetScore or Filter methods, or * if a multiplier was applied to the score by the AdjustScore method.
  • number
    The score returned by the SetScore method after any adjustments by the Filter or AdjustScore methods.
  • description
    The reason for the score change, as passed to the AdjustScore or SetScore methods, and set by the Filter method.

An example score tracing string is:

"Commerce.AdNod,=0.9875,Need of Delivery".

Requirements

Namespace: Microsoft.CommerceServer.Interop.Caching

Platforms: Windows 2000, Windows Server 2003

Assembly: cachecomplib (in cachecomplib.dll)

See Also

ContentList Class

ContentList.TraceMode

Copyright © 2005 Microsoft Corporation.
All rights reserved.