netScheduleJobEnum 函数 (lmat.h)
[NetScheduleJobEnum 自Windows 8起不再可用。 请改用 任务计划程序 2.0 接口。
]
NetScheduleJobEnum 函数列出在指定计算机上排队的作业。 此函数要求启动计划服务。
语法
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
);
参数
[in, optional] Servername
指向常量字符串的指针，该常量字符串指定要在其中执行函数的远程服务器的 DNS 或 NetBIOS 名称。 如果此参数为 NULL，则使用本地计算机。
[out] PointerToBuffer
指向接收数据的缓冲区的指针。 返回信息是 AT_ENUM 结构的数组。 缓冲区由系统分配，必须使用对 NetApiBufferFree 函数的单个调用来释放。 请注意，即使函数失败并出现ERROR_MORE_DATA，也必须释放缓冲区。
[in] PrefferedMaximumLength
一个 值，该值指示返回数据的首选最大长度（以字节为单位）。 如果指定MAX_PREFERRED_LENGTH，函数将分配数据所需的内存量。 如果在此参数中指定另一个值，它可以限制函数返回的字节数。 如果缓冲区大小不足以容纳所有条目，则函数将返回ERROR_MORE_DATA。 有关详细信息，请参阅 网络管理功能缓冲区 和 网络管理功能缓冲区长度。
[out] EntriesRead
指向接收实际枚举的元素计数的值的指针。
[out] TotalEntries
指向一个值的指针，该值接收可能从当前恢复位置枚举的条目总数。 请注意，应用程序应仅将此值视为提示。
[in, out] ResumeHandle
指向包含用于继续作业枚举的恢复句柄的值的指针。 第一次调用时，句柄应为零，后续调用应保持不变。 如果此参数为 NULL，则不存储任何恢复句柄。
返回值
如果函数成功，则返回值NERR_Success。
如果函数失败，则返回值为系统错误代码。 有关错误代码的列表，请参阅 系统错误代码。
注解
通常，只有枚举计划作业的计算机上的本地 Administrators 组的成员才能成功执行此函数。 如果 Servername 参数指向的字符串中传递的服务器名称是远程服务器，则只有服务器上的本地 Administrators 组的成员才能成功执行此函数。
如果以下注册表值具有 (（例如，0x00000001) ）设置的最小有效位，则属于服务器操作员组的用户也可以成功执行此函数。
HKLM\System\CurrentControlSet\Control\Lsa\SubmitControl
返回的每个条目都包含 AT_ENUM 结构。 调用需要作业标识符参数的函数（例如 NetScheduleJobDel 函数）时，可以使用 JobId 成员的值。
要求
| 要求 | 值 |
|---|---|
| 最低受支持的客户端 | Windows 2000 Professional [仅限桌面应用] |
| 最低受支持的服务器 | Windows 2000 Server [仅限桌面应用] |
| 目标平台 | Windows |
| 标头 | lmat.h (包括 Lmat.h) |
| Library | Netapi32.lib |
| DLL | Netapi32.dll |