AT_ENUM info  Overview  Group

The AT_ENUM structure enumerates and returns information about an entire queue of jobs that have already been submitted.

typedef struct _AT_ENUM {

    DWORD   JobId;

    DWORD   JobTime;

    DWORD   DaysOfMonth;

    UCHAR   DaysOfWeek;

    UCHAR   Flags;

    LPWSTR  Command;

} AT_ENUM, *PAT_ENUM, *LPAT_ENUM;

 

Members

JobID

Job identifier of an already submitted job.

JobTime

Time of day at which a job is scheduled to run. Time is a local time at a computer on which the Schedule service is running. Time is measured from midnight and is expressed in milliseconds.

DaysOfMonth

Bitmask for the days of the month on which a job is scheduled to run. The bitmask is NULL if a job was scheduled to run only once at the first occurrence of JobTime. For each bit that is set in the bitmask a job will run at JobTime on a corresponding day of the month. Bit 0 corresponds to first day of the month, and so on.

DaysOfWeek

Bitmask for the days of the week on which this job is scheduled to run. The bitmask is NULL if a job was scheduled to run only once at the first occurrence of JobTime. For each bit that is set in the bitmask a job will run at JobTime on a corresponding day of the week. Bit 0 corresponds to Monday (first day of the week), and so on.

Flags

Bitmask describing job properties. For job submission (NetScheduleJobAdd), possible values are:

JOB_RUN_PERIODICALLY

If this flag bit is set, the job runs on every day for which corresponding bits in DaysOfMonth or DaysOfWeek are set. If this flag bit is clear, the job runs only once for each bit that was set in DaysOfMonth or DaysOfWeek at the time of job submission.

JOB_ADD_CURRENT_DATE

When this flag bit is set, the job will also execute at the first occurrence of JobTime at the computer to which the job is submitted. In other words, setting this flag bit is equivalent to setting the corresponding day bit in the DaysOfMonth bitmask.

For job information retrieval (NetScheduleJobEnum and NetScheduleJobGetInfo), possible values are:

JOB_RUN_PERIODICALLY

This flag bit is equal to the original value of this flag bit when a job was submitted.

JOB_EXEC_ERROR

This flag bit is set whenever the Schedule service failed to execute successfully this job the last time this job was supposed to run.

JOB_RUNS_TODAY

This flag bit is set if JobId is larger than the current time of day at the computer at which this job is queued.

Command

Pointer to a Unicode string that contains the name of the command, batch program, or binary file to execute.

See Also

NetScheduleJobEnum