SQL-DMO

Status Property (Subscription Objects)

The Status property returns component execution or integrity state information.

Applies To
DistributionSubscription Object TransSubscription Object
MergeSubscription Object  

Syntax

object.Status [= value]

Parts

object

Expression that evaluates to an object in the Applies To list

value

Long integer that identifies the status of the referenced component as described in Settings

Data Type

Long, enumerated

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetStatus(SQLDMO_SUBSTATUS_TYPE* pRetVal);

HRESULT SetStatus(SQLDMO_SUBSTATUS_TYPE NewValue);

Settings
Constant Value Description
SQLDMOSubStat_Active 2 Subscription is active. Agent will maintain subscription.
SQLDMOSubStat_Default 1000 SQLDMOSubStat_Unknown.
SQLDMOSubStat_Inactive 0 Subscription is inactive. Agent will not maintain subscription.
SQLDMOSubStat_Unknown 1000 Subscription state cannot be known.
SQLDMOSubStat_Unsynced 1 Subscription has not been synchronized. Manual or automated synchronization must occur before agent can maintain subscription.