NetScheduleJobEnum function (lmat.h)

Article
10/13/2021

[NetScheduleJobEnum is no longer available for use as of Windows 8. Instead, use the Task Scheduler 2.0 Interfaces.

]

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

Syntax

NET_API_STATUS NET_API_FUNCTION NetScheduleJobEnum(
  [in, optional] LPCWSTR Servername,
  [out]          LPBYTE  *PointerToBuffer,
  [in]           DWORD   PrefferedMaximumLength,
  [out]          LPDWORD EntriesRead,
  [out]          LPDWORD TotalEntries,
  [in, out]      LPDWORD ResumeHandle
);

Parameters

[in, optional] Servername

A pointer to a constant string that specifies the DNS or NetBIOS name of the remote server on which the function is to execute. If this parameter is NULL, the local computer is used.

[out] PointerToBuffer

A pointer to the buffer that receives the data. The return information is an array of AT_ENUM structures. The buffer is allocated by the system and must be freed using a single call to the NetApiBufferFree function. Note that you must free the buffer even if the function fails with ERROR_MORE_DATA.

[in] PrefferedMaximumLength

A value that indicates the preferred maximum length of the returned data, in bytes. If you specify MAX_PREFERRED_LENGTH, the function allocates the amount of memory required for the data. If you specify another value in this parameter, it can restrict the number of bytes that the function returns. If the buffer size is insufficient to hold all entries, the function returns ERROR_MORE_DATA. For more information, see Network Management Function Buffers and Network Management Function Buffer Lengths.

[out] EntriesRead

A pointer to a value that receives the count of elements actually enumerated.

[out] TotalEntries

A pointer to a value that receives the total number of entries that could have been enumerated from the current resume position. Note that applications should consider this value only as a hint.

[in, out] ResumeHandle

A pointer to a value that contains a resume handle which is used to continue a job enumeration. The handle should be zero on the first call and left unchanged for subsequent calls. If this parameter is NULL, then no resume handle is stored.

Return value

If the function succeeds, the return value is NERR_Success.

If the function fails, the return value is a system error code. For a list of error codes, see System Error Codes.

Remarks

Normally only members of the local Administrators group on the computer where the schedule job is being enumerated can successfully execute this function. If the server name passed in the string pointed to by the Servername parameter is a remote server, then only members of the local Administrators group on the server can successfully execute this function.

If the following registry value has the least significant bit set (for example, 0x00000001), then users belonging to the Server Operators group can also successfully execute this function.

HKLM\System\CurrentControlSet\Control\Lsa\SubmitControl

Each entry returned contains an AT_ENUM structure. The value of the JobId member can be used when calling functions that require a job identifier parameter, such as the NetScheduleJobDel function.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	lmat.h (include Lmat.h)
Library	Netapi32.lib
DLL	Netapi32.dll