Restore.ReadMediaHeader Method

Reads the media header and returns the media header values.

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

Syntax

'Declaration
Public Function ReadMediaHeader ( _
    srv As Server _
) As DataTable
'Usage
Dim instance As Restore 
Dim srv As Server 
Dim returnValue As DataTable 

returnValue = instance.ReadMediaHeader(srv)
public DataTable ReadMediaHeader(
    Server srv
)
public:
DataTable^ ReadMediaHeader(
    Server^ srv
)
member ReadMediaHeader : 
        srv:Server -> DataTable
public function ReadMediaHeader(
    srv : Server
) : DataTable

Parameters

Return Value

Type: System.Data.DataTable
A DataTable object that specifies the media header data.

Examples

The following code example demonstrates how to back up file for the AdventureWorks2012 database and read the header values of the backup media.

VB

Dim srv As Server = New Server()
Dim res As Restore = New Restore()
Dim backup As Backup = New Backup()
Dim dt As DataTable

backup.Devices.AddDevice("C:\AdventureWorks2012Backup.bak", DeviceType.File)
backup.Database = "AdventureWorks2012"
backup.Action = BackupActionType.Database
backup.Initialize = True
backup.SqlBackup(srv)

res.Devices.AddDevice("C:\AdventureWorks2012Backup.BAK", DeviceType.File)
dt = res.ReadMediaHeader(srv)

For Each r As DataRow In dt.Rows
   For Each c As DataColumn In dt.Columns
      Console.WriteLine(c.ToString + " = " + r(c).ToString())
   Next
Next

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:\AdventureWorks2012Backup.bak", [Microsoft.SqlServer.Management.Smo.DeviceType]::File)
$backup.Database = "AdventureWorks2012"
$backup.Action = [Microsoft.SqlServer.Management.Smo.BackupActionType]::Database
$backup.Initialize = $TRUE
$backup.SqlBackup($srv)

$res.Devices.AddDevice("C:\AdventureWorks2012Backup.bak", [Microsoft.SqlServer.Management.Smo.DeviceType]::File)
$dt = $res.ReadMediaHeader($srv)

foreach($r in $dt.Rows)
{
   foreach ($c in $dt.Columns)
   {
      Write-Host $c "=" $r[$c]
   }
}

See Also

Reference

Restore Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

RESTORE (Transact-SQL)

Back Up and Restore of SQL Server Databases