• Article

MediaDescription Property

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 MediaDescription property provides informative text to aid in identification of a backup set

Syntax

object
.MediaDescription [= value]

Parts

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

  • value
    A 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 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 MediaDescription and MediaName properties are written to a tape medium when the medium is initialized.

Applies To:

Backup Object