• Article

SnapshotAgent 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 SnapshotAgent property identifies the SQL Server Agent job that starts the replication agent responsible for snapshot creation.

Syntax

object.SnapshotAgent [= value]

Parts

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

  • value
    A string that identifies a SQL Server Agent job by name

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetSnapshotAgent(SQLDMO_LPBSTR pRetVal);
HRESULT SetSnapshotAgent(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.