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 群組成員才能成功執行此函式。 如果 伺服器 名稱參數所指向之字串中傳遞的伺服器名稱是遠端伺服器,則只有伺服器上的本機 Administrators 群組成員可以成功執行此函式。
例如,如果下列登錄值設定最小有效位 (,0x00000001) ,則屬於伺服器操作員群組的使用者也可以成功執行此函式。
HKLM\System\CurrentControlSet\Control\Lsa\SubmitControl
傳回的每個專案都包含 AT_ENUM 結構。 呼叫需要作業標識符參數的函式時,可以使用 JobId 成員的值,例如 NetScheduleJobDel 函式。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows 2000 Professional [僅限傳統型應用程式] |
最低支援的伺服器 | Windows 2000 Server [僅限桌面應用程式] |
目標平台 | Windows |
標頭 | lmat.h (包含 Lmat.h) |
程式庫 | Netapi32.lib |
Dll | Netapi32.dll |