Module: Win32::TaskScheduler::TaskSchedulerConstants

Included in:
Win32::TaskScheduler
Defined in:
lib/win32/taskscheduler/constants.rb

Constant Summary collapse

SERVICE_ACCOUNT_USERS =
SID::SERVICE_ACCOUNT_USERS
BUILT_IN_GROUPS =
SID::BUILT_IN_GROUPS
SYSTEM_USERS =
SERVICE_ACCOUNT_USERS + BUILT_IN_GROUPS
TASK_TIME_TRIGGER_ONCE =

Trigger is set to run the task a single time

1
TASK_TIME_TRIGGER_DAILY =

Trigger is set to run the task on a daily interval

2
TASK_TIME_TRIGGER_WEEKLY =

Trigger is set to run the task on specific days of a specific week & month

3
TASK_TIME_TRIGGER_MONTHLYDATE =

Trigger is set to run the task on specific day(s) of the month

4
TASK_TIME_TRIGGER_MONTHLYDOW =

Trigger is set to run the task on specific day(s) of the month

5
TASK_EVENT_TRIGGER_ON_IDLE =

Trigger is set to run the task if the system remains idle for the amount of time specified by the idle wait time of the task

6
TASK_TRIGGER_REGISTRATION =
7
TASK_EVENT_TRIGGER_AT_SYSTEMSTART =

Trigger is set to run the task at system startup

8
TASK_EVENT_TRIGGER_AT_LOGON =

Trigger is set to run the task when a user logs on

9
TASK_TRIGGER_SESSION_STATE_CHANGE =
11
TASK_SUNDAY =

The task will run on Sunday

0x1
TASK_MONDAY =

The task will run on Monday

0x2
TASK_TUESDAY =

The task will run on Tuesday

0x4
TASK_WEDNESDAY =

The task will run on Wednesday

0x8
TASK_THURSDAY =

The task will run on Thursday

0x10
TASK_FRIDAY =

The task will run on Friday

0x20
TASK_SATURDAY =

The task will run on Saturday

0x40
TASK_FIRST_WEEK =

The task will run between the 1st and 7th day of the month

0x01
TASK_SECOND_WEEK =

The task will run between the 8th and 14th day of the month

0x02
TASK_THIRD_WEEK =

The task will run between the 15th and 21st day of the month

0x04
TASK_FOURTH_WEEK =

The task will run between the 22nd and 28th day of the month

0x08
TASK_LAST_WEEK =

The task will run the last seven days of the month

0x10
TASK_JANUARY =

The task will run in January

0x1
TASK_FEBRUARY =

The task will run in February

0x2
TASK_MARCH =

The task will run in March

0x4
TASK_APRIL =

The task will run in April

0x8
TASK_MAY =

The task will run in May

0x10
TASK_JUNE =

The task will run in June

0x20
TASK_JULY =

The task will run in July

0x40
TASK_AUGUST =

The task will run in August

0x80
TASK_SEPTEMBER =

The task will run in September

0x100
TASK_OCTOBER =

The task will run in October

0x200
TASK_NOVEMBER =

The task will run in November

0x400
TASK_DECEMBER =

The task will run in December

0x800
TASK_FLAG_INTERACTIVE =

Used when converting AT service jobs into work items

0x1
TASK_FLAG_DELETE_WHEN_DONE =

The work item will be deleted when there are no more scheduled run times

0x2
TASK_FLAG_DISABLED =

The work item is disabled. Useful for temporarily disabling a task

0x4
TASK_FLAG_START_ONLY_IF_IDLE =

The work item begins only if the computer is not in use at the scheduled start time

0x10
TASK_FLAG_KILL_ON_IDLE_END =

The work item terminates if the computer makes an idle to non-idle transition while the work item is running

0x20
TASK_FLAG_DONT_START_IF_ON_BATTERIES =

The work item does not start if the computer is running on battery power

0x40
TASK_FLAG_KILL_IF_GOING_ON_BATTERIES =

The work item ends, and the associated application quits, if the computer switches to battery power

0x80
TASK_FLAG_RUN_ONLY_IF_DOCKED =

The work item starts only if the computer is in a docking station

0x100
TASK_FLAG_HIDDEN =

The work item created will be hidden

0x200
TASK_FLAG_RUN_IF_CONNECTED_TO_INTERNET =

The work item runs only if there is a valid internet connection

0x400
TASK_FLAG_RESTART_ON_IDLE_RESUME =

The work item starts again if the computer makes a non-idle to idle transition

0x800
TASK_FLAG_SYSTEM_REQUIRED =

The work item causes the system to be resumed, or awakened, if the system is running on batter power

0x1000
TASK_FLAG_RUN_ONLY_IF_LOGGED_ON =

The work item runs only if a specified account is logged on interactively

0x2000
TASK_TRIGGER_FLAG_HAS_END_DATE =

The task will stop at some point in time

0x1
TASK_TRIGGER_FLAG_KILL_AT_DURATION_END =

The task can be stopped at the end of the repetition period

0x2
TASK_TRIGGER_FLAG_DISABLED =

The task trigger is disabled

0x4
TASK_RUNLEVEL_LUA =

Run Level Types Tasks will be run with the least privileges

0
TASK_RUNLEVEL_HIGHEST =

Tasks will be run with the highest privileges

1
TASK_LOGON_NONE =

Logon Types Used for non-NT credentials

0
TASK_LOGON_PASSWORD =

Use a password for logging on the user

1
TASK_LOGON_S4U =

The service will log the user on using Service For User

2
TASK_LOGON_INTERACTIVE_TOKEN =

Task will be run only in an existing interactive session

3
TASK_LOGON_GROUP =

Group activation. The groupId field specifies the group

4
TASK_LOGON_SERVICE_ACCOUNT =

When Local System, Local Service, or Network Service account is being used as a security context to run the task

5
TASK_LOGON_INTERACTIVE_TOKEN_OR_PASSWORD =

Not in use; currently identical to TASK_LOGON_PASSWORD

6
TASK_MAX_RUN_TIMES =
1440
TASKS_TO_RETRIEVE =
5
TASK_VALIDATE_ONLY =

Task creation

0x1
TASK_CREATE =
0x2
TASK_UPDATE =
0x4
TASK_CREATE_OR_UPDATE =
0x6
TASK_DISABLE =
0x8
TASK_DONT_ADD_PRINCIPAL_ACE =
0x10
TASK_IGNORE_REGISTRATION_TRIGGERS =
0x20
REALTIME_PRIORITY_CLASS =

Priority classes

0
HIGH_PRIORITY_CLASS =
1
ABOVE_NORMAL_PRIORITY_CLASS =

Or 3

2
NORMAL_PRIORITY_CLASS =

Or 5, 6

4
BELOW_NORMAL_PRIORITY_CLASS =

Or 8

7
IDLE_PRIORITY_CLASS =

Or 10

9
CLSCTX_INPROC_SERVER =
0x1
CLSID_CTask =
[0x148BD520, 0xA2AB, 0x11CE, 0xB1, 0x1F, 0x00, 0xAA, 0x00, 0x53, 0x05, 0x03].pack("LSSC8")
CLSID_CTaskScheduler =
[0x148BD52A, 0xA2AB, 0x11CE, 0xB1, 0x1F, 0x00, 0xAA, 0x00, 0x53, 0x05, 0x03].pack("LSSC8")
IID_ITaskScheduler =
[0x148BD527, 0xA2AB, 0x11CE, 0xB1, 0x1F, 0x00, 0xAA, 0x00, 0x53, 0x05, 0x03].pack("LSSC8")
IID_ITask =
[0x148BD524, 0xA2AB, 0x11CE, 0xB1, 0x1F, 0x00, 0xAA, 0x00, 0x53, 0x05, 0x03].pack("LSSC8")
IID_IPersistFile =
[0x0000010b, 0x0000, 0x0000, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46].pack("LSSC8")
TASK_FIRST =

Days of month

0x01
TASK_SECOND =
0x02
TASK_THIRD =
0x04
TASK_FOURTH =
0x08
TASK_FIFTH =
0x10
TASK_SIXTH =
0x20
TASK_SEVENTH =
0x40
TASK_EIGHTH =
0x80
TASK_NINETH =
0x100
TASK_TENTH =
0x200
TASK_ELEVENTH =
0x400
TASK_TWELFTH =
0x800
TASK_THIRTEENTH =
0x1000
TASK_FOURTEENTH =
0x2000
TASK_FIFTEENTH =
0x4000
TASK_SIXTEENTH =
0x8000
TASK_SEVENTEENTH =
0x10000
TASK_EIGHTEENTH =
0x20000
TASK_NINETEENTH =
0x40000
TASK_TWENTIETH =
0x80000
TASK_TWENTY_FIRST =
0x100000
TASK_TWENTY_SECOND =
0x200000
TASK_TWENTY_THIRD =
0x400000
TASK_TWENTY_FOURTH =
0x800000
TASK_TWENTY_FIFTH =
0x1000000
TASK_TWENTY_SIXTH =
0x2000000
TASK_TWENTY_SEVENTH =
0x4000000
TASK_TWENTY_EIGHTH =
0x8000000
TASK_TWENTY_NINTH =
0x10000000
TASK_THIRTYETH =
0x20000000
TASK_THIRTY_FIRST =
0x40000000
TASK_LAST =
0x80000000