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

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

'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)