TASKPAGE enumeration (mstask.h)

  • Article

[[This API may be altered or unavailable in subsequent versions of the operating system or product. Please use the Task Scheduler 2.0 Enumerated Types instead.] ]

Defines the type of task page to be retrieved.

Each property page can be used to define the properties of a task object.

Syntax

typedef enum _TASKPAGE {
  TASKPAGE_TASK = 0,
  TASKPAGE_SCHEDULE = 1,
  TASKPAGE_SETTINGS = 2
} TASKPAGE;

Constants

 
TASKPAGE_TASK
Value: 0
Specifies the Task page for the task. This page provides the following UI elements:






  • Run: This field specifies the name of the application associated with the task.

  • This property can also be set programmatically by calling
    ITask::SetApplicationName.

  • Start in: This field specifies the working directory for the task.

  • This property can also be set programmatically by calling
    ITask::SetWorkingDirectory.

  • Comments: This field specifies any application-defined comments for the task.

  • This property can also be set programmatically by calling
    IScheduledWorkItem::SetComment.

  • Run as: (Windows Server 2003, Windows XP, and Windows 2000 only.) This field specifies the account name under which the task will run. To the right of this field is a Password button for specifying the password for the account.

  • This property can also be set programmatically by calling
    IScheduledWorkItem::SetAccountInformation.

  • Enabled (scheduled task runs at specific time): This checkbox specifies whether the TASK_TRIGGER_FLAG_DISABLED flag is set.

  • This property can also be set by setting this flag in the rgFlags member of the
    TASK_TRIGGER structure.
TASKPAGE_SCHEDULE
Value: 1
Specifies the Schedule page for the task. This page is used to manage the triggers for the task. The user can create triggers, edit triggers, and delete triggers from this page.




This page provides the following UI elements:


  • Trigger list box: This list box is displayed only if multiple triggers exist.

  • Schedule Task: This field specifies how often the task will run: daily, weekly, monthly, once, at system startup, at logon, or when idle.

  • Start Time: This field specifies the time of day the task will run.

  • Advanced: This button allows you to set the start date and end date for running the task.

  • Schedule Task group box: This group box is only displayed if the Schedule Task field specifies daily, weekly, monthly, or once.

  • Show multiple schedules: Shows all triggers. When checked, Trigger list box is displayed.
TASKPAGE_SETTINGS
Value: 2
Specifies the Settings page for the task. The user can specify what happens when the task is completed, idle conditions, and power management properties for the task.




This page provides the following UI elements:


  • Scheduled Task Completed group box: This group box includes check boxes for setting the TASK_FLAG_DELETE_WHEN_DONE flag and the maximum run time for the task.

  • The TASK_FLAG_DELETE_WHEN_DONE flag can also be set programmatically by calling
    IScheduledWorkItem::SetFlags. The maximum run time can be set by calling
    ITask::SetMaxRunTime.

  • Idle Time group box: This group box includes fields for setting idle conditions.

  • The idle time can also be set programmatically by calling
    IScheduledWorkItem::SetIdleWait. The TASK_FLAG_START_ONLY_IF_IDLE and TASK_FLAG_KILL_ON_IDLE_END flags can be set by calling
    IScheduledWorkItem::SetFlags.

  • Power management group box: (Windows 95 only) This group box includes check boxes for indicating how the task behaves when the system is losing power.

  • These properties can also be set programmatically by setting the TASK_FLAG_DONT_START_IF_ON_BATTERIES and TASK_FLAG_KILL_IF_GOING_ON_BATTERIES flags using
    IScheduledWorkItem::SetFlags.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Header mstask.h

See also

IProvideTaskPage::GetPage

IScheduledWorkItem::SetAccountInformation

IScheduledWorkItem::SetComment

IScheduledWorkItem::SetFlags

IScheduledWorkItem::SetIdleWait

ITask::SetApplicationName

ITask::SetMaxRunTime

ITask::SetWorkingDirectory

TASK_TRIGGER