Share via

ContentList.AdjustScore Method (PIA)

  • Article

Use this method to adjust the score of an item in the ContentList object by applying a multiplier.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Caching
…
Public Sub AdjustScore(RowNum As Integer,
 Multiplier As Single,
 OptionalComponent As String,
 Optional Description As String)

[C#]

using Microsoft.CommerceServer.Interop.Caching;
…
public void AdjustScore(intRowNum,
 floatMultiplier,
 stringComponent,
 stringDescription);

Parameters

[Visual Basic .NET]

  • RowNum
    An Integer that contains the position of the item in the ContentList object for which the score is to be adjusted. Positions are counted from zero (0), not from one (1).
  • Multiplier
    A Single that contains the value by which the score will be multiplied.
  • Component
    An optional String that contains an identifier for the pipeline component that is adjusting the score. By convention, this is the ProgID of the pipeline component.
  • Description
    An optional String that contains a description to be appended to the score adjustment tracing string. This string should briefly describe the nature of the adjustment.

[C#]

  • RowNum
    A int that contains the position of the item in the ContentList object for which the score is to be adjusted. Positions are counted from zero (0), not from one (1).
  • Multiplier
    A float that contains the value by which the score will be multiplied.
  • Component
    A string that contains an identifier for the pipeline component that is adjusting the score. By convention, this is the ProgID of the pipeline component. Set to Type.Missing to omit the component.
  • Description
    A string that contains a description to be appended to the score adjustment tracing string. This string should briefly describe the nature of the adjustment. Set to Type.Missing to omit a description.

Exceptions

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

Remarks

Values for the Component and Description parameters are optional, but at least one parameter must be passed. These parameters are ignored unless the TraceMode property is set to true.

This method assumes that the ContentList object has a column of type CLCOL_R4 with the CLCOL_SCORE_COLUMN flag set.

[Visual Basic .NET]

Example

myContentList.AdjustScore(1, 1.25)

Requirements

Namespace: Microsoft.CommerceServer.Interop.Caching

Platforms: Windows 2000, Windows Server 2003

Assembly: cachecomplib (in cachecomplib.dll)

See Also

ContentList Class

Copyright © 2005 Microsoft Corporation.
All rights reserved.