ContentListSchema.ColumnFlags Property (PIA)

Article
11/12/2009

The ColumnFlags property is a read/write Integer that contains the column flags.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Caching
…
Public Property ColumnFlags(vColumn As Object) As Integer

[C#]

Get method:

using Microsoft.CommerceServer.Interop.Caching;
…
public int get_ColumnFlags(object vColumn);

Put method:

using Microsoft.CommerceServer.Interop.Caching;
…
public void set_ColumnFlags(object vColumn,
 intColumnFlags);

Parameters

[Visual Basic .NET]

vColumn
An Object that contains either the column name or the column position in order to identify the column in question. Column positions are counted from zero (0), not one (1).

[C#]

vColumn
A object that contains either the column name or the column position in order to identify the column in question. Column positions are counted from zero (0), not one (1).
ColumnFlags
When setting the property, an int that contains the new column flag settings, represented as a bit field.

Return Values

This property returns an Integer indicating the current column flag settings, represented as a bit field.

Exceptions

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

Remarks

[C#]get_ColumnFlags does not show up in IntelliSense.

Column flags are represented as a bit field. The following table shows the meanings of the bits that are used and the constants provided for manipulating those bits.

Bit	Constant	Description
1	CLCOL_READONLY (= 0x01)	When the bit is set, data in the column is read-only, and cannot be updated. This will be common for data stored in the ContentListFactory object since that data is shared between multiple page requests. When the bit is cleared, data in the column is read/write, and can be freely updated. No record locking is performed, so update contention could occur when updating data in the ContentListFactory object. This is not a concern for columns that are marked Private since they exist in the individual instances of ContentList objects, and ContentList objects are typically created for and used by a single thread.
2	CLCOL_PRIVATE (= 0x02)	When the bit is set, the data in the column is private to each ContentList object based on this schema. This means that the data is stored separately in each ContentList object that is created, and not stored in the shared columns in the corresponding ContentListFactory object.
4	CLCOL_SCORE_COLUMN (= 0x04)	When the bit is set it indicates that the data in this column is the score value associated with the content item. The type of this column must be a single-precision floating-point type (CLCOL_R4); only one column in the schema can have this flag set. Further, since a unique score value must be associated with each individual page request, this bit can only be set in conjunction with the CLCOL_PRIVATE bit. In other words, it must be a column stored in the ContentList object, as opposed to the ContentListFactory object, that is marked as the score column.

Requirements

Namespace: Microsoft.CommerceServer.Interop.Caching

Platforms: Windows 2000, Windows Server 2003

Assembly: cachecomplib (in cachecomplib.dll)

Share via