IndexOnTable Property

SQL-DMO

SQL-DMO

IndexOnTable Property

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

Applies To
Index2 Object
Syntax

object.IndexOnTable

Parts

object

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" are returned.