Partager via


IsBuiltInColumn Method

Helper to determine if a column is marked as a built in database column.

Namespace:  Microsoft.CommerceServer.Catalog
Assembly:  Microsoft.CommerceServer.Catalog (in Microsoft.CommerceServer.Catalog.dll)

Syntax

'Declaration
Public Shared Function IsBuiltInColumn ( _
    columnName As String _
) As Boolean
'Usage
Dim columnName As String
Dim returnValue As Boolean

returnValue = CatalogDefinitionsDataSetSchema.IsBuiltInColumn(columnName)
public static bool IsBuiltInColumn(
    string columnName
)
public:
static bool IsBuiltInColumn(
    String^ columnName
)
public static function IsBuiltInColumn(
    columnName : String
) : boolean

Parameters

Return Value

Type: System..::.Boolean
true to indicate columnName is a built in column; otherwise, false.

Remarks

Used to determine if a column is marked as a built in the CatalogDefinitions database column.

This method does not report a built in column at the catalog system level.

For example;

CatalogDefintionsDataSetSchema.IsBuiltInColumn("DefinitionId ") will return true since "DefinitionId" is a built in property in the CatalogDefinitionsDataSet.

However, CatalogPropertiesDataSetSchema.IsBuiltInColumn("DefinitionId") will return false since "DefinitionId" is not a build in property in the CatalogPropertiesDataSet.

The following catalog database columns in the CatalogDefinitions table are marked built in:

  • DefinitionId

  • DefinitionName

  • DefinitionType

  • Description

Permissions

See Also

Reference

CatalogDefinitionsDataSetSchema Class

CatalogDefinitionsDataSetSchema Members

Microsoft.CommerceServer.Catalog Namespace