RelocateFiles 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 RelocateFiles property specifies database logical file names and operating system physical file names used to redirect database storage when a Microsoft SQL Server database is restored to a new physical location.

Syntax

object.RelocateFiles [= value]

Parts

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

  • value
    A SQL Distributed Management Objects (SQL-DMO) multistring built as specified in Remarks.

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetRelocateFiles(SQLDMO_LPBSTR pRetVal);
HRESULT SetRelocateFiles(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

When creating a string directing physical file relocation, build the string as the current logical name of the database file, then the new operating system file name. Repeat pairings of logical name and physical name until all files implementing the database are specified. For example:

oRestore.RelocateFiles = "[Northwind1]" + "," + "[D:\Data\North_1.mdf]" _
    + "," + "[Northwind2]" + "," + "[D:\Data\North_2.mdf]"

For more information about setting multistring parameters, see Using SQL-DMO Multistrings.

Applies To: