MediaDescription Property

SQL-DMO

SQL-DMO

MediaDescription Property

The MediaDescription property provides informative text to aid in identification of a backup set

Applies To
Backup Object  
Syntax

object.MediaDescription [= value]

Parts

object

Expression that evaluates to an object in the Applies To list

value

String of no more than 100 characters

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetMediaDescription(SQLDMO_LPBSTR pRetVal);

HRESULT SetMediaDescription(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 MediaDescription and MediaName properties are written to a tape media when the media is initialized.