NotificationClass.ExpirationAge Property

  • Article

Gets or sets the amount of time to elapse before unsent messages of the notification class are considered to have expired.

Namespace: Microsoft.SqlServer.Management.Nmo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public Property ExpirationAge As TimeSpan

public TimeSpan ExpirationAge { get; set; }

public:
property TimeSpan ExpirationAge {
    TimeSpan get ();
    void set (TimeSpan value);
}

/** @property */
public TimeSpan get_ExpirationAge ()

/** @property */
public void set_ExpirationAge (TimeSpan value)

public function get ExpirationAge () : TimeSpan

public function set ExpirationAge (value : TimeSpan)

Property Value

A TimeSpan object that specifies the expiration age for notifications from the notification class.

Remarks

If no ExpirationAge value is specified, notifications never expire. Notification Services continues to attempt delivery of all notifications until the retry schedule is exhausted.

During delivery, Notification Services ignores any notifications that have expired per the ExpirationAge value.

To remove the expiration age value from a deployed application, you must set the value to TimeSpan.Zero.

Example

The following examples show how to set the expiration age for notifications generated for a notification class:

flightNotifications.ExpirationAge = new TimeSpan(2, 0, 0);

flightNotifications.ExpirationAge = New TimeSpan(2, 0, 0)

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

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

See Also

Reference

NotificationClass Class
NotificationClass Members
Microsoft.SqlServer.Management.Nmo Namespace

Other Resources

Defining Notification Classes
Specifying the Notification Expiration Age
ExpirationAge Element (ADF)