Share via


MediaPassword 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 MediaPasswordproperty sets or retrieves the password for a media set.

Syntax

object.MediaPassword[= value]

Parts

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

  • value
    A string that contains the password

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetMediaPassword(SQLDMO_LPBSTR pRetVal);
HRESULT SetMediaPassword(SQLDMO_LPCSTR NewValue);

Remarks

The MediaPassword property provides the password used for a media set. If a media set password exists, it must be supplied to perform any restore operation from the media set. If no media set password is passed by the Backup2 object, MediaPassword is set to NULL. An application can set MediaPassword multiple times; however, after a backup or restore operation has been performed, MediaPassword cannot be altered.

Note

If an application calls MediaPassword on an instance of Microsoft SQL Server version 7.0, the operation is ignored.

See Also

Reference