AltSnapshotFolder Property

SQL-DMO

Syntax

object.AltSnapshotFolder [=value]

Parts

object

Expression that evaluates to an object in the Applies To list

value

String that specifies an alternate path for snapshot files

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetAltSnapshotFolder(SQLDMO_LPBSTR pRetVal);

HRESULT SetAltSnapshotFolder(SQLDMO_LPCSTR NewValue);

Remarks

When used with the MergePublication2 or TransPublication2 objects, the AltSnapshotFolder property specifies an alternate location to use for snapshot file creation when a snapshot must be transported to a Subscriber. When used with the MergePullSubscription2 or TransPullSubscription2 objects, AltSnapshotFolder specifies an alternate location to use for snapshot file application.

Transporting a snapshot file using portable media, such a removable hard drive, can be useful in situations where a Subscriber is not continuously connected. Transporting a snapshot file may also be desirable in a situation where a large amount of data might otherwise have to be applied using an expensive connection.

AltSnapshotFolder is required if the publication attribute SQLDMOPubAttrib_InternetEnabled is set.

Note  If an application sets AltSnapshotFolder with the MergePublication2 or TransPublication2 object after the initial snapshot has been created, a new snapshot must be generated. Snapshots are applied when the next scheduled snapshot agent runs.

Note  If an application calls AltSnapshotFolder on an instance of Microsoft® SQL Server™ version 7.0, the constant, SQLDMO_E_SQL80ONLY, and the message "This property or method requires Microsoft SQL Server 2000" are returned.