Функция NetScheduleJobEnum (lmat.h)

Статья
08/24/2023

[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.

Если функция завершается сбоем, возвращаемое значение представляет собой системный код ошибки. Список кодов ошибок см. в разделе Системные коды ошибок.

Обычно только члены локальной группы администраторов на компьютере, на котором выполняется перечисление задания расписания, могут успешно выполнять эту функцию. Если имя сервера, переданное в строке, на которую указывает параметр Servername , является удаленным сервером, то только члены локальной группы администраторов на сервере могут успешно выполнить эту функцию.

Если в следующем значении реестра задан наименьший бит (например, 0x00000001), пользователи, входящие в группу Операторы сервера, также могут успешно выполнить эту функцию.

HKLM\System\CurrentControlSet\Control\Lsa\SubmitControl

Каждая возвращаемая запись содержит структуру AT_ENUM . Значение элемента JobId можно использовать при вызове функций, которым требуется параметр идентификатора задания, например функции NetScheduleJobDel .

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	lmat.h (включая Lmat.h)
Библиотека	Netapi32.lib
DLL	Netapi32.dll