CheckAllocations 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 CheckAllocations method scans all pages of the referenced database on Microsoft SQL Server 2000 and later, testing pages to ensure integrity.
Syntax
object.CheckAllocations( [ RepairType ] )as String
Parts
object
Expression that evaluates to an object in the Applies To list.RepairType
Optional. A long integer that specifies database repair action as described in Settings.
Prototype (C/C++)
HRESULT CheckAllocations(SQLDMO_LPBSTR pResult,
SQLDMO_DBCC_REPAIR_TYPE lType = SQLDMORepair_None);
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.
Settings
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 string that contains error detail information.
Remarks
The database referenced by the SQL-DMO object must be in single-user mode when using the RepairType argument of the CheckAllocations method to perform database repair. To set single-user mode on a database using SQL-DMO, use the SingleUser property of the DBOption object.
The CheckAllocations method is implemented using the Transact-SQL DBCC CHECKALLOC statement. The return value of CheckAllocations is a string representation of the error messages returned by DBCC CHECKALLOC.