Task Properties

Task Object Properties Methods Lists Collections

Property Description

ActiveEndDate
    Date
    Write: Yes
The date and time after which this task is active.
ActiveStartDate
    Date
    Write: Yes
The date and time before which this task is active.
Application
    Application
    Write: No
The Application object.
Command
    String
    Write: Yes
The Transact-SQL statement to execute for this task.
Database
    Identifier
    Write: Yes
Database to execute this task in.
DateCreated
    String
    Write: No
The date and time this task was created.
DateModified
    String
    Write: No
The date and time this task was last changed.
Description
    String
    Write: Yes
Description of this task.
EmailCompletionLevel
    SQLOLE_COMPLETION_TYPE
    Write: Yes
The task completion status which causes notification of the operator by email.
EmailOperator
    String
    Write: Yes
Mail address of operator for notifications.
Enabled
    Boolean
    Write: Yes
Determines if this task is active and enabled. If True, this task is active and will be fired when scheduled. If False, the task is disabled and will not be fired.
FrequencyInterval
    Long
    Write: Yes
The number of days between daily tasks, the day of the week for weekly tasks, or the day of the month for monthly tasks, on which this task will occur.
FrequencyRecurrenceFactor
    Long
    Write: Yes
The number of weeks between weekly tasks, or the number of months between monthly tasks.
FrequencyRelativeInterval
    SQLOLE_FREQRELATIVE_TYPE
    Write: Yes
The day of the month for monthly relative tasks, on which this task will occur.
FrequencySubDay
    SQLOLE_FREQSUB_TYPE
    Write: Yes
Within a specific day, the subday frequency unit of time, by minute or by hour.
FrequencySubDayInterval
    Long
    Write: Yes
The number of minutes between minutely tasks, or the number of hours between hourly tasks.
FrequencyType
    SQLOLE_FREQUENCY_TYPE
    Write: Yes
The primary frequency unit of time.
ID
    Long
    Write: No
The task ID.
LastRunCompletionLevel
    SQLOLE_COMPLETION_TYPE
    Write: No
The task completion status of the last execution of this task.
LastRunDate
    Date
    Write: No
The date and time this task was last executed.
LastRunDuration
    Long
    Write: No
The duration of the last execution of this task. Has the form HHHHMMSS, where HHHH is the number of hours, MM is the number of minutes, and SS is the number of seconds.
LastRunRetries
    Long
    Write: No
The number of retry attempts during the previous exection of this task.
LogHistoryCompletionLevel
    SQLOLE_COMPLETION_TYPE
    Write: Yes
The task completion status which causes task history information to be logged.
Name
    Identifier
    Write: Yes
Task name.
NextRunDate
    Date
    Write: No
The date and time this task will next execute.
Owner
    Identifier
    Write: No
The user who created this task.
Parent
    Executive
    Write: No
The Executive object.
RetryAttempts
    Long
    Write: Yes
The number of retries to attempt when a task execution fails.
RetryDelay
    Long
    Write: Yes
The delay in minutes between retry attempts.
RunPriority
    SQLOLE_RUNPRIORITY_TYPE
    Write: Yes
The Windows NT thread priority to use when executing this task.
SubSystem
    String
    Write: Yes
The subsystem used by a replication task. Can be "Distribution", "LogReader", or "Sync".
TagAdditionalInfo
    String
    Write: Yes
Temporary storage space contained in this object used by replication. For Task objects created by the application, this temporary storage space is available for private use by the application. SQL-DMO does not use this property.
TagObjectID
    Long
    Write: Yes
Temporary storage space contained in this object used by replication. For Task objects created by the application, this temporary storage space is available for private use by the application. SQL-DMO does not use this property.
TagObjectType
    Long
    Write: Yes
Temporary storage space contained in this object used by replication. For Task objects created by the application, this temporary storage space is available for private use by the application. SQL-DMO does not use this property.
TargetSQLServer
    Identifier
    Write: Yes
The SQL Server to execute this task on. For use with replication tasks only.
TypeOf
    SQLOLE_OBJECT_TYPE
    Write: No
The type of object.
User
    Identifer
    Write: Yes
The database user to use when executing this task.
UserData
    Long
    Write: Yes
Temporary storage space contained in this object for private use by the application. SQL-DMO does not use this property.