ReadBackupHeader Method (SQLServer) (SQL-DMO)

The ReadBackupHeader method returns a QueryResults object enumerating the contents of the media maintained by a backup device or operating system file.

Applies To

SQLServer Object

Syntax

object.ReadBackupHeader( Restore ) as QueryResults

Returns

A QueryResults object containing one result set. For a description of the result set contents, see ReadBackupHeader Method (BackupDevice).

Remarks

When using the ReadBackupHeader method, one of the Restore object device properties must indicate the device or file maintaining the backup media.

To use the ReadBackupHeader method

1. Create a SQLServer object.
2. Connect the SQLServer object to the Microsoft® SQL Server™ installation on which the source backup device is visible.
3. Create a Restore object.
4. Set either the Devices, Files, Pipes, or Tapes property to indicate a device visible on the SQL Server installation indicated in Step 2 and maintaining the backup media. Specify only a single device or file.
5. If desired, set the FileNumber property to indicate a specific backup set by ordinal location on the media. By default, the header of the first backup set on the media is enumerated.
6. Call the ReadBackupHeader method of the SQLServer object using the Restore object created in Step 3 as an argument.

SQL Server can share backup media with other operating system utilities that perform backup of other data, and the media in a device may contain headers created by other utilities.

When the media of a backup device is unused, such as when a disk device is empty, the ReadBackupHeader method succeeds, returning an empty QueryResults object.

Prototype (C/C++)

HRESULT ReadBackupHeader(
LPSQLDMORESTORE Restore,
LPSQLDMOQUERYRESULTS* ppResults);