SubscriptionID Property

SQL-DMO

SQL-DMO

SubscriptionID Property

The SubscriptionID property returns the subscription ID, which is a unique identifier, as a string.

Applies To

TransPullSubscription2 Object MergePullSubscription2 Object

Syntax

object.SubscriptionID

Parts

object

Expression that evaluates to an object in the Applies To list

Data Type

String

Modifiable

Read-only

Prototype (C/C++)

HRESULT GetSubscriptionID(SQLDMO_LPBSTR pRetVal);

Remarks

When cleaning up anonymous agent meta data at a Distributor, an application can retrieve the subscription ID using the SubscriptionID property. The application can then use the value in the bstrSubscriptionID parameter of the CleanUpAnonymousAgentInfo method.

Note  If an application calls SubscriptionID on 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.

See Also

CleanUpAnonymousAgentInfo Method