ContentList Object

  • Article

Ee798382.c++_off(en-US,CS.10).gifEe798382.vb_on(en-US,CS.10).gif

Use this object to access a particular collection of content items. The ContentList object provides aggregated access to the private data that it stores and to the shared data stored in the ContentListFactory object that created it. This object also flows through the Content Selection Framework (CSF) pipeline for the purpose of scoring content items.

ProgID:   Dependent (See Remarks for more information)
COM Class Name:   ContentList
COM Interface Name:   IContentList
Interface ID Constant:   IID_IContentList
Header File:   cacheint.h, mspu_guids.h
Type Library Name:   Microsoft Commerce 2000 Cache Manager Type Library
DLL Name:   mscscache.dll
Threading Model:   Both

In C++, use the IContentList and IDataContainer interfaces to access the methods and properties of a ContentList object.

The properties of the ContentList object are shown in the following table.

Property Type Description
ActiveRows IRowCollection The collection of rows that meet the current Threshold and RowLimit properties and that have not been filtered out of the ContentList object.

This property is read-only.
AllRows IRowCollection Contains a RowCollection object containing all rows in this ContentList object.

This property is read-only.
Count long Contains the number of rows in this ContentList object.

This property is read/write.
Factory IContentListFactory Contains the ContentListFactory object that created this ContentList object.

This property is read-only.
Fields Fields Contains the Fields collection for this ContentList object.

This property is read-only.
RowLimit long Contains the maximum number of active rows.

This property is read/write.
Sorted VARIANT_BOOL Stores a flag that controls whether or not the rows in the ActiveRows collection property are returned sorted by score.

This property is read/write.
Threshold float Contains the Threshold score required for active rows.

This property is read/write.
TraceMessages ISimpleList Stores the list of TraceMessage strings accumulated for a particular row in the ContentList object.

This property is read-only.
TraceMode VARIANT_BOOL Stores the TraceMode value. A value of True enables score tracing, a value of False disables it.

This property is read/write.

The methods of the ContentList object are shown in the following table.

Method Description
AdjustScore Adjusts the score associated with an item in the ContentList object by applying a multiplier.
BuildIndex Builds an index on the specified column.
Filter Filters items in a ContentList object based on the specified criteria.
GetData Gets data from a specified row and column in a ContentList object in a high-performance, non-scriptable manner.
GetScore Gets the score of an item in a ContentList object.
Search Returns a RowCollection object containing the collection of content items that match the search criteria.
SetData Sets data at a specified row and column in a ContentList object in a high-performance, non-scriptable manner.
SetScore Sets the score of an item in a ContentList object.

Remarks

Both the ContentList object and the ContentListFactory object implement a common interface, IDataContainer. Therefore, they share the following methods and properties, which are functionally identical on both objects:

Properties:

  • AllRows

  • Count

  • Fields

Methods:

  • BuildIndex

  • GetData

  • Search

  • SetData

The function of a ContentList object is:

  • To aggregate private data in the ContentList object with shared data in the ContentListFactory object.

  • To provide functionality for scoring, searching, and filtering the list of content.

The ContentList object is a dependent object. Create a new ContentList object and obtain a pointer to its IContentList interface by calling the method IContentListFactory::CreateNewContentList.

Ee798382.important(en-US,CS.10).gif Important

  • The ContentList and the ContentListFactory objects are designed to be run in-process with their clients. The GetData and SetData methods assume direct memory access for performance reasons.


All rights reserved.