Create method of the Win32_ScheduledJob class

The Create WMI class method submits a job to an operating system for execution at a specified time and date in the future. This method requires that the schedule service be started on the computer to which the job is submitted.

This topic uses Managed Object Format (MOF) syntax. For more information about using this method, see Calling a Method.

Syntax

uint32 Create(
  [in]           string   Command,
  [in]           datetime StartTime,
  [in, optional] boolean  RunRepeatedly,
  [in, optional] uint32   DaysOfWeek,
  [in, optional] uint32   DaysOfMonth,
  [in, optional] boolean  InteractWithDesktop,
  [out]          uint32   JobId
);

Parameters

Command [in]

Name of the command, batch program, or binary file and command-line parameters that the schedule service uses to invoke the job.

Example: "defrag /q /f".

StartTime [in]

Coordinated Universal Time (UTC) time to run a job. The form must be: "YYYYMMDDHHMMSS.MMMMMM(+-)OOO", where "YYYYMMDD" must be replaced by "********". For example: "********143000.000000-420" specifies 14.30 (2:30 P.M.) PST with daylight savings time in effect.

The "(+-)OOO" section of the StartTime property value is the current bias for local time translation. The bias is the difference between the UTC time and the local time. To calculate the bias for your time zone, multiply the number of hours that your time zone is ahead or behind Greenwich Mean Time (GMT) by 60 (use a positive number for the number of hours if your time zone is ahead of GMT and a negative number if your time zone is behind GMT). Add an additional 60 to your calculation if your time zone is using daylight savings time. For example, the Pacific Standard Time zone is eight hours behind GMT, therefore the bias is equals to -420 (-8 * 60 + 60) when daylight savings time is in use and -480 (-8 * 60) when daylight savings time is not in use. You can also determine the value of the bias by querying the bias property of the Win32_TimeZone class.

RunRepeatedly [in, optional]

If True, a scheduled job runs repeatedly on specific days. The default is False.

DaysOfWeek [in, optional]

Days of the week when a job is scheduled to run; used only when the RunRepeatedly parameter is True. To schedule a job for more than one day of the week, join the appropriate values in a logical OR. For example, to schedule a job for Tuesdays and Fridays, the value of DaysOfWeek are 2 OR 16.

Monday (1)

Tuesday (2)

Wednesday (4)

Thursday (8)

Friday (16)

Saturday (32)

Sunday (64)

Return value

Returns a value of 0 (zero) when successful, and a different number to indicate an error. For additional error codes, see WMI Error Constants or WbemErrorEnum. For general HRESULT values, see System Error Codes.

Successful completion

0

The request is accepted.

Not supported

1

The request is not supported.

Access denied

2

The user does not have the necessary access.

Unknown failure

8

Interactive process.

Path not found

9

The directory path to the service executable file cannot be found.

Invalid parameter

21

Invalid parameters have been passed to the service.

Service not started

22

The account that this service runs under is invalid or lacks the permissions to run the service.

Other

23 4294967295

Remarks

If your scheduled job starts an interactive program such as Notepad, then the InteractWithDeskto property must be set to True or the program's screen is not visible. The process still appears in the Task Manager even if it does not appear on the screen.

Requirements

See also

Operating System Classes

Win32_ScheduledJob