• Article

BrowseSnapshotFolder Method (TransPublication2)

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 BrowseSnapshotFolder method returns the complete path used to apply the most recent snapshot.

Syntax

object.BrowseSnapshotFolder( 
[ szSubscriberName ] , 
[ szSubscriberDB ] ) as String

Parts

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

  • SzSubscriberName
    String that specifies the Subscriber name.

  • szSubscriberDB
    String that specifies the name of the subscription database at the Subscriber.

Prototype (C/C++)

HRESULT BrowseSnapshotFolder(
SQLDMO_LPBSTR pszSnapshotFolder, 
SQLDMO_LPCSTR szSubscriberName, 
SQLDMO_LPCSTR szSubscriberDB);

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 by using SysFreeString.

Remarks

BrowseSnapshotFolder is useful for determining the directory where snapshot files are generated. If the AltSnapshotFolder property is set, BrowseSnapshotFolderreturns the folder location.

Optionally, use the SzSubscriberName and szSubscriberDB parameters to locate snapshot files generated for a particular subscription. If SzSubscriberName and szSubscriberDB are not specified, BrowseSnapshotFolder returns the location of the last snapshot folder used.

Note

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