IContentList::AdjustScore Method
Use this method to adjust the score of an item in the ContentList object by applying a multiplier.
HRESULT IContentList::AdjustScore(
long RowNum,
float Multiplier,
BSTR Component,
BSTR Description
);
Sub AdjustScore(
RowNum As Long,
Multiplier As Float,
Component As String,
Description As String
)
Parameters
RowNum
[C++][in] A long 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).
[Visual Basic]
A Long 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
[C++][in] A float that contains the value by which the score will be multiplied.
[Visual Basic]
A Float that contains the value by which the score will be multiplied.
Component
[C++][in,optional] A BSTR that contains an identifier for the pipeline component that is adjusting the score. By convention, this is the Programmatic Identifier (ProgID) of the pipeline component.
[Visual Basic]
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
[C++][in,optional] A BSTR that contains a description to be appended to the score adjustment tracing string. This string should briefly describe the nature of the adjustment.
[Visual Basic]
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.
Return Value
[C++]
This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.
[Visual Basic]
None.
Error Values
[C++]
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.
[Visual Basic]
This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM 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. In particular, the Description property may contain a text description of the error.
Remarks
The Component and Description parameters are optional. They 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.
Example
myContentList.AdjustScore 1, 1.25