Export (0) Print
Expand All

Backup.BackupSetDescription Property

Gets or sets a textual description for a particular backup set.

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

public string BackupSetDescription { get; set; }

Property Value

Type: String
A String value that contains a textual description of the backup set. By default, the value is an empty string.

The BackupSetDescription property value is limited to 255 characters.

VB

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

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database
$db = $srv.Databases.Item("AdventureWorks2012")
$bk = new-object Microsoft.SqlServer.Management.Smo.Backup
$bk.BackupSetDescription = "Full backup of AdventureWorks2012"
$bk.Database = "AdventureWorks2012"
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft