wmi Win32_ScheduledJob reference for Network Programming in .NET with C# & Visual Basic .NET (VB.NET)

WMI class ' Win32_ScheduledJob ' reference for C# and VB.NET

MOF Reference

[Description("The Win32_ScheduledJob class represents a job scheduled using the network management schedule service functions (also known as \"Job\" and \"AT command\" functions). Note that this is different from the tasks scheduled using the Windows 2000 Task Scheduler. This class is only instrumented on Windows NT 4.0 and later.  Each job scheduled against the schedule service is stored persistently (the scheduler will know to start the job even after a reboot) and is executed at the specified time and day of the week and/or month.  If the computer is not active or if the scheduled service is not running at the specified job time the schedule service will run the specified job on the next day at the specified time.  Scheduled jobs are scheduled with respect to Universal Coordinated Time (UTC), i.e. with bias offset from GMT.  This means that a job can be specified using any time zone specification.  The Win32_ScheduledJob class will return the local time with UTC offset when enumerating an object and convert to local time when creating new jobs.  For example a job specified to run on a computer in Boston at 10:30 pm Monday PST time will be scheduled to run locally at 1:30am Tuesday EST.  It should be noted that a client must take into account whether daylight savings time is in operation on the local computer and if so subtract a bias of 60 minutes from the UTC offset."): ToSubClass, AMENDMENT, LOCALE(1033)]
class Win32_ScheduledJob : CIM_Job
{
	[Description("The StartTime property represents the UTC time to run the job, in the form of YYYYMMDDHHMMSS.MMMMMM(+-)OOO, where YYYYMMDD must be replaced by ********.  The replacement is necessary because the scheduling service only allows jobs to be configured on a day of the month, day of the week, or run once. A job cannot be run on a specific date.\nExample: ********123000.000000-420 which implies 12:30 pm PST with daylight savings time in effect."): ToSubClass] datetime StartTime = NULL;
	[Description("The JobStatus property indicates whether a scheduled service executed successfully the last time this job was supposed to run."): ToSubClass, Values{"Success", "Failure"}: ToSubClass] string JobStatus = NULL;
	[key, Description("The JobId property indicates the identifier number of the job.  It is used by methods as a handle to a single job being scheduled on this computer."): ToSubClass] uint32 JobId;
	[Description("The Command property contains the name of the command, batch program, or binary file (along with command line arguments) that the schedule service will use to invoke the job.\nExample: defrag /q /f"): ToSubClass] string Command;
	[Description("The RunRepeatedly property indicates whether the scheduled job should run repeatedly on the days that the job is scheduled.\nValues: TRUE or FALSE.  If TRUE, then the job is run repeatedly.  If FALSE, then the job is run once."): ToSubClass] boolean RunRepeatedly;
	[Description("The InteractWithDesktop property allows the specified job to be interactive (meaning a user can give input to a scheduled job while it is executing).\nValues TRUE or FALSE.  If TRUE, then the job will be interactive.  If FALSE, then the job will not be interactive."): ToSubClass] boolean InteractWithDesktop;
	[Description("The DaysOfWeek property indicates the days of the week when the job is scheduled to run."): ToSubClass, BitValues{"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"}: ToSubClass] uint32 DaysOfWeek;
	[Description("The DaysOfMonth property indicates the days of the month when the job is scheduled to run."): ToSubClass, BitValues{"1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31"}: ToSubClass] uint32 DaysOfMonth;
	[Description("The Create function submits a job to the operating system for execution at a specified future time and date.  This function requires that the schedule service be started at the computer towhich the job is submitted. The method returns an integer value which can be interpretted as follows: \n0 - Successful completion\n1 - Not supported\n2 - Access denied\n8 - Unknown failure\n9 - Path not found\n21 - Invalid parameter\n22 - Service not started\nOther - For integer values other than those listed above, refer to Win32 error code documentation."): ToSubClass, Values{"Successful completion", "Not supported", "Access denied", "Unknown failure", "Path not found", "Invalid parameter", "Service not started", "Other"}: ToSubClass] uint32 Create([In, Description("The Command parameter contains the name of the command, batch program, or binary file (along with command line parameters) that the schedule service will use to invoke the job.\nExample: defrag /q /f"): ToSubClass] string Command, [In, Description("The StartTime parameter represents the UTC time to run the job.  This is of the form YYYYMMDDHHMMSS.MMMMMM(+-)OOO, where YYYYMMDD must be replaced by ********.\nExample: ********123000.000000-420 which implies 12:30 pm PST with daylight savings time in effect."): ToSubClass] datetime StartTime, [In, Description("The RunRepeatedly parameter indicates whether the scheduled job should run repeatedly on the days that the job is scheduled.\nValues: TRUE or FALSE.  If TRUE, then the job is run repeatedly according to the DaysOfWeek and DaysOfMonth parameter. If no value is supplied the parameter defaults to FALSE."): ToSubClass] boolean RunRepeatedly, [In, Description("The DaysOfWeek parameter indicates the days of the week when the job is scheduled to run, and is used only when the RunRepeatedly parameter is TRUE."): ToSubClass, BitValues{"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"}: ToSubClass] uint32 DaysOfWeek, [In, Description("The DaysOfMonth parameter indicates the days of the month when the job is scheduled to run, and is used only when the RunRepeatedly parameter is TRUE."): ToSubClass, BitValues{"1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31"}: ToSubClass] uint32 DaysOfMonth, [In, Description("The InteractWithDesktop parameter indicates whether the specified job should be interactive (meaning a user can give input to the scheduled job while it is executing).\nValues TRUE or FALSE.  If TRUE, then the job will be interactive.  The default value of this parameter is FALSE."): ToSubClass] boolean InteractWithDesktop, [Out, Description("The JobId parameter indicates the identifier number of the job.  This parameter is a handle to the job being scheduled on this computer."): ToSubClass] uint32 JobId);
	[Description("The Delete method deletes a scheduled job. The method returns an integer value which can be interpretted as follows: \n0 - Successful completion\n1 - Not supported\n2 - Access denied\n8 - Unknown failure\n9 - Path not found\n21 - Invalid parameter\n22 - Service not started\nOther - For integer values other than those listed above, refer to Win32 error code documentation."): ToSubClass, Values{"Successful completion", "Not supported", "Access denied", "Unknown failure", "Path not found", "Invalid parameter", "Service not started", "Other"}: ToSubClass] uint32 Delete();
};

Class properties:

Win32_ScheduledJob.Caption
Win32_ScheduledJob.Command
Win32_ScheduledJob.DaysOfMonth
Win32_ScheduledJob.DaysOfWeek
Win32_ScheduledJob.Description
Win32_ScheduledJob.ElapsedTime
Win32_ScheduledJob.InstallDate
Win32_ScheduledJob.InteractWithDesktop
Win32_ScheduledJob.JobId
Win32_ScheduledJob.JobStatus
Win32_ScheduledJob.Name
Win32_ScheduledJob.Notify
Win32_ScheduledJob.Owner
Win32_ScheduledJob.Priority
Win32_ScheduledJob.RunRepeatedly
Win32_ScheduledJob.StartTime
Win32_ScheduledJob.Status
Win32_ScheduledJob.TimeSubmitted
Win32_ScheduledJob.UntilTime

WMI is a huge subject, so therefore it is practically impossible to provide a comprehensive example program that covers anything. However, the book �Network programming in .NET� (Buy at Amazon UK) (Buy at Amazon US) covers a much wider scope of WMI, and explains how to leverage it to access the bounty of information held within this vast, yet simple object model.

Articles

Contact us

Please use FireFox to view this page

WMI class ' Win32_ScheduledJob ' reference for C# and VB.NET

MOF Reference

Class properties: