Share via

  • Article

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 _
)
'Usage
Dim instance As Server
Dim mediaSetId As Integer

instance.DeleteBackupHistory(mediaSetId)

public void DeleteBackupHistory(
    int mediaSetId
)

public:
void DeleteBackupHistory(
    int mediaSetId
)

member DeleteBackupHistory : 
        mediaSetId:int -> unit 

public function DeleteBackupHistory(
    mediaSetId : int
)

Parameters

  • mediaSetId
    Type: System.Int32
    An Int32 value that specifies the index number of the media set for which the backup history is deleted.

Remarks

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.

Examples

Visual Basic

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

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

PowerShell

$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")
$srv.DeleteBackupHistory(1)