Share via

BackupDevice.ReadBackupHeader Method

  • Article

Enumerates the contents of the media maintained by a backup device or operating system file.

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public Function ReadBackupHeader As DataTable

public DataTable ReadBackupHeader ()

public:
DataTable^ ReadBackupHeader ()

public DataTable ReadBackupHeader ()

public function ReadBackupHeader () : DataTable

Return Value

A DataTable system object that contains the backup device or operating system file media information.

Remarks

The ReadBackupHeader method returns the backup header information into a DataTable object. The information returned is dependent on the version of SQL Server and is equivalent to the RESTOR HEADER ONLY Transact-SQL command.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

How to: Back Up Databases and Transaction Logs in Visual Basic .NET

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

BackupDevice Class
BackupDevice Members
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Backing Up and Restoring Databases in SQL Server
Backup Devices