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)
Syntax
'Declaration
Public Property BackupSetDescription As String
Get
Set
'Usage
Dim instance As Backup
Dim value As String
value = instance.BackupSetDescription
instance.BackupSetDescription = value
public string BackupSetDescription { get; set; }
public:
property String^ BackupSetDescription {
String^ get ();
void set (String^ value);
}
member BackupSetDescription : string with get, set
function get BackupSetDescription () : String
function set BackupSetDescription (value : String)
Property Value
Type: System.String
A String value that contains a textual description of the backup set. By default, the value is an empty string.
Remarks
The BackupSetDescription property value is limited to 255 characters.
Examples
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"
See Also
Reference
Microsoft.SqlServer.Management.Smo Namespace