NetScheduleJobEnum

Overview

Group

Quick Info

Windows NT
Yes
Win95
No
Win32s
No
Import Library
netapi32.lib
Header File
lmat.h
Unicode
WinNT
Platform Notes
All LanMan APIs are UNICODE only

The NetScheduleJobEnum function lists the jobs queued on a specified computer. This function requires that the Schedule service be started.

Security Requirements
Only members of the Administrators local group can successfully execute NetScheduleJobEnum on a remote server.

NET_API_STATUS NetScheduleJobEnum(

LPWSTR Servername,
LPBYTE *PointerToBuffer,
DWORD PreferredMaximumLength,
LPDWORD EntriesRead,
LPDWORD TotalEntries,
LPDWORD ResumeHandle
);

Parameters
Servername
Pointer to a Unicode string containing the name of the remote server on which the function is to execute. A NULL pointer or string specifies the local computer.

PointerToBuffer
On return a pointer to the return information structure is returned in the address pointed to by PointerToBuffer. The return information structure is an array of AT_ENUM data structures.

PreferredMaximumLength
Preferred maximum length, in 8-bit bytes of returned data.

EntriesRead
Pointer to a DWORD that contains the actual enumerated element count.

TotalEntries
Pointer to a DWORD that contains the total number of entries that could have been enumerated from the current resume position.

ResumeHandle
Pointer to a DWORD that contains ResumeHandle, which is used to continue an job enumeration. The handle should be zero on the first call and left unchanged for subsequent calls. If ResumeHandle is NULL, then no resume handle is stored.

Note Each entry returned contains the JobId number of the AT_ENUM structure. The value of this member can be used in functions that require job identifier argument, such as NetScheduleJobDel.