IContentList::get_TraceMessages

Ee823774.c++_off(en-US,CS.10).gifEe823774.vb_on(en-US,CS.10).gif

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

Get method:

HRESULT IContentList::get_TraceMessages(longRowNum,ISimpleList**TraceMessages);

Parameters

RowNum

[in] A long that contains the position of the row for which the trace messages will be returned. Row positions start at zero (0), not one (1).

TraceMessages

[out,retval] The address of a pointer used to return the ISimpleList interface of the SimpleList object that contains the trace messages.

Return Values

These methods return an HRESULT indicating whether or not they completed successfully. See the Error Values section for more details.

Error Values

This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

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".

See Also

ContentList Object


All rights reserved.