IContentList::SetScore

Ee823929.c++_off(en-US,CS.10).gifEe823929.vb_on(en-US,CS.10).gif

Use this method to set a new score for an item in a ContentList object.

Definition

HRESULT IContentList::SetScore(longRowNum,floatScore,BSTRComponent,BSTRDescription);

Parameters

RowNum

[in] A long that contains the position of the item in the ContentList object for which a new score will be set. Positions are counted from zero (0), not from one (1).

Score

[in] A float that contains the new score.

Component

[in,optional] A BSTR that is intended to contain the name of the pipeline component that is setting the new score. This parameter is optional and is used for score tracing.

Description

[in,optional] A BSTR that is intended to contain the reason that the score is being set; for example, Need of Delivery. This parameter is optional and is used for score tracing.

Return Values

This method returns an HRESULT indicating whether or not it 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 Component and Description parameters are optional.

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

For the sake of uniformity, pipeline components provided with Commerce Server 2000 pass the Programmatic Identifier (ProgID) of the component for the Component parameter.

See Also

ContentList Object


All rights reserved.