CheckIndex Method

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 CheckIndex method tests the integrity of database pages implementing storage for the referenced index.

Syntax

object.CheckIndex( )as String

Parts

  • object
    Expression that evaluates to an object in the Applies To list.

Prototype (C/C++)

HRESULT CheckIndex(SQLDMO_LPBSTR pResult);

Note

SQL Distributed Management Objects (SQL-DMO) strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference using SysFreeString.

Returns

A string that contains error detail information

Remarks

The CheckIndex method is implemented using the Transact-SQL DBCC CHECKTABLE statement, which specifies the test of the index by indicating the index identifier. The return value of the CheckIndex method is a string representation of the error messages returned by DBCC CHECKTABLE.

Applies to:

See Also

Reference