Share via

  • Article

Backup.BackupSetName Property

Gets or sets the name used to identify a particular backup set.

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

Syntax

'Declaration
Public Property BackupSetName As String
    Get
    Set
'Usage
Dim instance As Backup
Dim value As String

value = instance.BackupSetName

instance.BackupSetName = value

public string BackupSetName { get; set; }

public:
property String^ BackupSetName {
    String^ get ();
    void set (String^ value);
}

member BackupSetName : string with get, set

function get BackupSetName () : String
function set BackupSetName (value : String)

Property Value

Type: System.String
A String value that specifies the backup set name. By default, the value is set to an empty string.

Remarks

The BackupSetName property value is limited to 128 characters.

Examples

VB

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Reference the AdventureWorks2008R2 database.
Dim db As Database
db = srv.Databases("AdventureWorks2008R2")
'Define a Backup object variable. 
Dim bk As New Backup
'Specify the the name of the database to be backed up.
bk.BackupSetName = "AdventureWorks2008R2 Backup"
bk.Database = "AdventureWorks2008R2"

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database
$db = $srv.Databases.Item("AdventureWorks2008R2")
$bk = new-object Microsoft.SqlServer.Management.Smo.Backup
$bk.BackupSetName = "AdventureWorks2008R2 Backup"
$bk.Database = "AdventureWorks2008R2"