BackupSetDescription Property

SQL-DMO

SQL-DMO

BackupSetDescription Property

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

Applies To
Backup Object  
Syntax

object.BackupSetDescription [= value]

Parts

object

Expression that evaluates to an object in the Applies To list

value

String

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetBackupSetDescription(SQLDMO_LPBSTR pRetVal);

HRESULT SetBackupSetDescription(SQLDMO_LPCSTR NewValue);

Note  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.