Subscription.Enabled Property

Article
12/03/2008

Gets or sets the status of a subscription.

Namespace: Microsoft.SqlServer.NotificationServices
Assembly: Microsoft.SqlServer.NotificationServices (in microsoft.sqlserver.notificationservices.dll)

Syntax

'Declaration
Public Property Enabled As Boolean

public bool Enabled { get; set; }

public:
virtual property bool Enabled {
    bool get () sealed;
    void set (bool value) sealed;
}

/** @property */
public final boolean get_Enabled ()

/** @property */
public final void set_Enabled (boolean value)

public final function get Enabled () : boolean

public final function set Enabled (value : boolean)

Property Value

A Boolean value indicating whether the subscription is enabled.

Remarks

This property gets or sets the status of a subscription, by changing the value of the Enabled field in the subscription record.

The Enabled property allows you to enable or disable a subscription within the Notification Services system. When the Enabled property value is true, the subscription is active and can generate notifications. When the Enabled property value is false, the subscription is disabled and cannot generate notifications.

This property default is true.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms