ActiveEndTimeOfDay Property

SQL-DMO

SQL-DMO

ActiveEndTimeOfDay Property

The ActiveEndTimeOfDay property indicates the last effective time for a schedule.

Applies To
Schedule Object
Syntax

object.ActiveEndTimeOfDay [= value]

Parts

object

Expression that evaluates to an object in the Applies To list

value

Long integer representing a time

Data Type

Long

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetActiveEndTimeOfDay(LPLONG pRetVal);

HRESULT SetActiveEndTimeOfDay(LONG NewValue);

Remarks

Scheduled SQL Server Agent activities, such as jobs, can have begin and end times. A job is run at the points indicated in a schedule only between the begin time and the end time. Alter the ActiveEndTimeOfDay property to set the time at which the schedule is no longer in effect.

A schedule can have an ending time of day and yet not have an ending date. Schedules with an ending time, but no ending date are effective for every scheduled occurrence between the begin and end time. For example, a schedule may specify job execution every hour, beginning at 12 A.M. and ending at 6 A.M.

Note  When SQL-DMO uses a scaled long integer to represent a time, the integer is built as a sum of the hour scaled by 10000, the minute scaled by 100, and the seconds. The time value uses a 24-hour clock. For example, the time 1:03:09 P.M. is represented by the long integer value 130309.