DropSubscription Method

Replication Programming

Replication Programming

DropSubscription Method

The DropSubscription method drops the subscription having the specified control properties.

Applies To

SQLDistribution Object

SQLMerge Object

Syntax

object.DropSubscription DBDropOption

Part Description
object Expression that evaluates to an object in the Applies To list.
DBDropOption Option to drop; use a value from DBDROPOPTION.
Remarks

Push subscriptions are not currently supported by this method.

If DROP_DATABASE is specified, the database is dropped even when the subscription specified by the SubscriptionName property does not exist. Error notification is not provided.

DropSubscription also supports dropping the subscription without dropping the database and unregistering the subscription from Windows Synchronization Manager.

In Microsoft® Visual Basic®, DropSubscription is a Sub method and does not return a value.

Prototype C/C++

HRESULT DropSubscription(
    DBDROPOPTION DBDropOption);

Return code Description
S_OK Method succeeded.
E_FAIL General failure occurred. Check error records for detailed information.
REPLX_E_SUBNOTFOUND Specified subscription does not exist.
REPLX_E_RETRYFAILURE Failure occurred that might require retrying the last operation.

See Also

AddSubscription Method

CopySubscription Method

DBDROPOPTION

SubscriptionName Property