BackupSetDescription Property

  • Article

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The BackupSetDescription property provides descriptive or identifying text for the result of a backup operation.

Syntax

object
.BackupSetDescription [=value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list
  • value
    A string

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetBackupSetDescription(SQLDMO_LPBSTR pRetVal);
HRESULT SetBackupSetDescription(SQLDMO_LPCSTR NewValue);

Note

SQL Distributed Management Objects (SQL-DMO) strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference using SysFreeString.

Remarks

The BackupSetDescription property value is limited to 255 characters. There is no default value.

Applies To:

Backup Object