Server.DeleteBackupHistory Method (Int32)

Deletes the backup history for the specified media set.

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

Syntax

'Declaration
Public Sub DeleteBackupHistory ( _
    mediaSetId As Integer _
)
public void DeleteBackupHistory (
    int mediaSetId
)
public:
void DeleteBackupHistory (
    int mediaSetId
)
public void DeleteBackupHistory (
    int mediaSetId
)
public function DeleteBackupHistory (
    mediaSetId : int
)

Parameters

  • mediaSetId

Remarks

Updated text:

Use this method to remove backup history logs for a media set on the instance of SQL Server. If a media set is being retired, then use this method to remove the backup history only for that media set.

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

Example

'Connect to the local, default instance of SQL Server.
Dim srv2 As Server
srv2 = New Server

'Delete backup history from the media set specified.
srv3.DeleteBackupHistory(1)

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

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

Other Resources

How to: Use an SMO Method with a Parameter in Visual Basic .NET
Backing Up and Restoring Databases in SQL Server
Calling Methods
Managing Servers

Change History

Release

History

New content:
  • Added code sample to the Example section.

  • Added to the description in the Remarks section.