• Article

Restore.SqlVerify Method (Server, Boolean, String%)

Checks the media on the instance of SQL Server that is represented by the specified Server object, loads backup history information into the history tables, and returns an error message.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.SmoExtended (in Microsoft.SqlServer.SmoExtended.dll)

Syntax

'Declaration
Public Function SqlVerify ( _
    srv As Server, _
    loadHistory As Boolean, _
    <OutAttribute> ByRef errorMessage As String _
) As Boolean
'Usage
Dim instance As Restore
Dim srv As Server
Dim loadHistory As Boolean
Dim errorMessage As String
Dim returnValue As Boolean

returnValue = instance.SqlVerify(srv, _
    loadHistory, errorMessage)

public bool SqlVerify(
    Server srv,
    bool loadHistory,
    out string errorMessage
)

public:
bool SqlVerify(
    Server^ srv, 
    bool loadHistory, 
    [OutAttribute] String^% errorMessage
)

member SqlVerify : 
        srv:Server * 
        loadHistory:bool * 
        errorMessage:string byref -> bool 

public function SqlVerify(
    srv : Server, 
    loadHistory : boolean, 
    errorMessage : String
) : boolean

Parameters

  • loadHistory
    Type: System.Boolean
    A Boolean value that specifies whether the history tables will be populated with pertinent backup information.
    If True, the history tables are populated. Otherwise, False.
  • errorMessage
    Type: System.String%
    A String value that contains the error message when the method has completed running. This is an output parameter.

Return Value

Type: System.Boolean
A Boolean value that indicates whether targeted backup set is readable and complete.
If True, the backup set was successfully verified. Otherwise, False.

Examples

The following code example demonstrates how to create a backup of the AdventureWorks2008R2 database and verify that it is readable and complete.

VB

Dim srv As Server = New Server("(local)")
Dim res As Restore = New Restore()
Dim backup As Backup = New Backup()

backup.Devices.AddDevice("C:\AdventureWorks2008R2Backup.bak", DeviceType.File)
backup.Database = "AdventureWorks2008R2"
backup.SqlBackup(srv)

res.Devices.AddDevice("C:\AdventureWorks2008R2Backup.bak", DeviceType.File)
res.Database = "AdventureWorks2008R2"
Console.WriteLine(res.SqlVerify(srv, true, "The verification has failed.").ToString())

Powershell

$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")
$res = new-object Microsoft.SqlServer.Management.Smo.Restore
$backup = new-object Microsoft.SqlServer.Management.Smo.Backup

$backup.Devices.AddDevice("C:\AdventureWorks2008R2Backup.bak", [Microsoft.SqlServer.Management.Smo.DeviceType]::File)
$backup.Database = "AdventureWorks2008R2"
$backup.SqlBackup($srv)

$res.Devices.AddDevice("C:\AdventureWorks2008R2Backup.bak", [Microsoft.SqlServer.Management.Smo.DeviceType]::File)
Write-Host $res.SqlVerify($srv, $TRUE, [ref]"The verification has failed.")