IndexOnTable Property

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The IndexOnTable property specifies whether an index is defined for a table or a view.

Syntax

object.IndexOnTable

Parts

  • object
    An expression that evaluates to an object in the Applies To list

Data Type

Boolean

Modifiable

Read-only

Prototype (C/C++)

HRESULT GetIndexOnTable(LPBOOL pRetVal);

Remarks

If the IndexOnTable property returns TRUE (the default), the index is defined for a table.

If IndexOnTable returns FALSE, the index is defined for an indexed view.

Use the Count property of the Indexes collection to enumerate indexes on a table or view.

Note

If an application calls IndexOnTable on an instance of SQL Server version 7.0, the constant, SQLDMO_E_SQL80ONLY, and the message "This property or method requires Microsoft SQL Server 2000 or later" are returned.

Applies To: