SnapshotJobID Property

SQL-DMO

SQL-DMO

SnapshotJobID Property

The SnapshotJobID property returns a system-generated value uniquely identifying the Microsoft® SQL Server™ 2000 Agent job that implements initial snapshot-generation of third party published article data.

Applies To
DistributionPublication2 Object TransPublication Object
MergePublication Object  
Syntax

object.SnapshotJobID

Parts

object

Expression that evaluates to an object in the Applies To list

Data Type

String

Modifiable

Read-only

Prototype (C/C++)

HRESULT GetSnapshotJobID(SQLDMO_LPBSTR pRetVal);

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

The property returns an empty string if no snapshot job is associated with the third-party publication. To associate a snapshot job with a third-party publication, a user needs to create a Microsoft® SQL Server™ 2000 Agent job that implements initial snapshot-generation of third-party published article data, and then associate the snapshot job with a third-party publication by setting snapshot job name using the SnapshotAgent property of the DistributionPublication2 object.

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