VacuumSchedule.StartTime Property

Article
12/03/2008

Gets or sets the daily time, in Universal Coordinated Time (UTC), for the data removal process to start.

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

Syntax

'Declaration
Public Property StartTime As TimeSpan

public TimeSpan StartTime { get; set; }

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

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

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

public function get StartTime () : TimeSpan

public function set StartTime (value : TimeSpan)

Property Value

A TimeSpan object that specifies the time of day for the vacuum process to start.

Remarks

The start time must be specified in UTC.

If you indicate a date as well as a time for this value, Notification Services uses only the time portion. The data removal process starts at the specified time on the current day.

Example

The following examples show how to create a schedule for removing obsolete data and then add the schedule to the collection of vacuum schedules for the application:

VacuumSchedule vacuumSchedule1 = new VacuumSchedule(
    myApplication, "1");
vacuumSchedule1.StartTime = new TimeSpan(23, 0, 0);
myApplication.VacuumSchedules.Add(vacuumSchedule1);

Dim vacuumSchedule1 As VacuumSchedule = _
    New VacuumSchedule(myApplication, "1")
vacuumSchedule1.StartTime = New TimeSpan(23, 0, 0)
myApplication.VacuumSchedules.Add(vacuumSchedule1)

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