CheckAllocationsWithResult 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 CheckAllocationsWithResult method scans all pages of the referenced database on Microsoft SQL Server 2000 and later, testing pages to ensure integrity.
Syntax
object
.CheckAllocationsWithResult( [ RepairType ] )as QueryResults
Parts
object
Expression that evaluates to an object in the Applies To list.RepairType
A long integer that specifies database repair action as described in Settings.
Prototype (C/C++)
HRESULT CheckAllocationsWithResult(
LPSQLDMOQUERYRESULTS * ppResults,
SQLDMO_DBCC_REPAIR_TYPE lType );
Settings
Set RepairType using these values.
Constant |
Value |
Description |
|---|---|---|
SQLDMORepair_Allow_/DataLoss |
3 |
Attempt all database repairs regardless of the possibility of data loss. For example, delete corrupted text objects. |
SQLDMORepair_Fast |
1 |
Attempt database repair tasks that do not incur data loss. |
SQLDMORepair_None |
0 |
Default. Do not attempt database repair on database inconsistencies encountered. |
SQLDMORepair_Rebuild |
2 |
Attempt database repair tasks that do not incur data loss. Rebuild indexes on successful database repair. |
Returns
A QueryResults object that contains detailed status and error information in tabular format.
Remarks
The database referenced by the SQL Distributed Management Objects (SQL-DMO) object must be in single-user mode when using the RepairType argument of the CheckAllocationsWithResult method to perform database repair. To set single-user mode on a database using SQL-DMO, use the SingleUser property of the DBOption object.
If no repair action is specified, RepairType defaults to SQLDMORepair_None.
CheckAllocationsWithResult is implemented using the Transact-SQL DBCC CHECKALLOC WITH TABLERESULTS statement, and differs from the CheckAllocationsmethod in that results are returned in tabular format.
It is recommended that you use the properties and methods of the QueryResults object to retrieve information from the result set.
Note
If an application calls CheckAllocationsWithResult 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.