Share via


RetentionPeriod Property

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The RetentionPeriod property specifies a number of days or hours for limiting any subscription to the publication.

Syntax

object
.RetentionPeriod [= value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list.
  • value
    A long integer. For the MergePublication object, RetentionPeriod specifies a number of days. For the TransPublication object, the property specifies a number of hours.

Data Type

Long

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetRetentionPeriod(LPDWORD pRetVal);
HRESULT SetRetentionPeriod(DWORD NewValue);

Remarks

A subscription is dropped by the system if the Subscriber identified has not accessed the referenced publication within the period specified by the RetentionPeriod property. The maximum value of the RetentionPeriod property is 2147483647.

Applies To:

MergePublication Object

TransPublication Object