ReadMediaHeader Method (Restore) (SQL-DMO)

The ReadMediaHeader method returns a QueryResults object enumerating the values of a backup media header record.

Applies To

Restore Object

Syntax

object.ReadMediaHeader( Server ) as QueryResults

Returns

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

Remarks

A database backup performed by SQL Server can target multiple devices of a single type and can span multiple media maintained by the device. To organize media used in backup, SQL Server defines the media set and media family. A media label, or header record, maintains data about a media’s location within a media set and media family.

To use the ReadMediaHeader method

1. Create a SQLServer object.
2. Connect the SQLServer object to the 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 or operating system file visible on the SQL Server installation created in Step 1 and maintaining the backup media.
5. Call the ReadMediaHeader method of the Restore object using the SQLServer object created in Step 1 as an argument.

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

Prototype (C/C++)

HRESULT ReadMediaHeader(
LPSQLDMOSERVER ServerObject,
LPSQLDMOQUERYRESULTS* ppResults);

See Also

Understanding Media Sets and Families