Función NetScheduleJobEnum (lmat.h)

[NetScheduleJobEnum ya no está disponible para su uso a partir de Windows 8. En su lugar, use las interfaces del Programador de tareas 2.0.

]

La función NetScheduleJobEnum enumera los trabajos en cola en un equipo especificado. Esta función requiere que se inicie el servicio de programación.

Sintaxis

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
);

Parámetros

[in, optional] Servername

Puntero a una cadena constante que especifica el nombre DNS o NetBIOS del servidor remoto en el que se va a ejecutar la función. Si este parámetro es NULL, se usa el equipo local.

[out] PointerToBuffer

Puntero al búfer que recibe los datos. La información de retorno es una matriz de estructuras de AT_ENUM . El sistema asigna el búfer y se debe liberar mediante una sola llamada a la función NetApiBufferFree . Tenga en cuenta que debe liberar el búfer incluso si se produce un error en la función con ERROR_MORE_DATA.

[in] PrefferedMaximumLength

Valor que indica la longitud máxima preferida de los datos devueltos, en bytes. Si especifica MAX_PREFERRED_LENGTH, la función asigna la cantidad de memoria necesaria para los datos. Si especifica otro valor en este parámetro, puede restringir el número de bytes que devuelve la función. Si el tamaño del búfer no es suficiente para contener todas las entradas, la función devuelve ERROR_MORE_DATA. Para obtener más información, consulte Búferes de funciones de administración de red y longitudes de búfer de funciones de administración de red.

[out] EntriesRead

Puntero a un valor que recibe el recuento de elementos enumerados realmente.

[out] TotalEntries

Puntero a un valor que recibe el número total de entradas que se podrían haber enumerado a partir de la posición de reanudación actual. Tenga en cuenta que las aplicaciones solo deben tener en cuenta este valor como sugerencia.

[in, out] ResumeHandle

Puntero a un valor que contiene un identificador de reanudación que se usa para continuar con una enumeración de trabajos. El identificador debe ser cero en la primera llamada y dejar sin cambios para las llamadas posteriores. Si este parámetro es NULL, no se almacena ningún identificador de reanudación.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto se NERR_Success.

Si se produce un error en la función, el valor devuelto es un código de error del sistema. Para obtener una lista de códigos de error, consulte Códigos de error del sistema.

Comentarios

Normalmente, solo los miembros del grupo administradores locales en el equipo donde se enumera el trabajo de programación pueden ejecutar correctamente esta función. Si el nombre del servidor pasado en la cadena a la que apunta el parámetro Servername es un servidor remoto, solo los miembros del grupo administradores locales del servidor pueden ejecutar correctamente esta función.

Si el siguiente valor del Registro tiene el bit menos significativo establecido (por ejemplo, 0x00000001), los usuarios que pertenecen al grupo Operadores de servidor también pueden ejecutar correctamente esta función.

HKLM\System\CurrentControlSet\Control\Lsa\SubmitControl

Cada entrada devuelta contiene una estructura AT_ENUM . El valor del miembro JobId se puede usar al llamar a funciones que requieren un parámetro de identificador de trabajo, como la función NetScheduleJobDel .

Requisitos

Requisito Value
Cliente mínimo compatible Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado lmat.h (include Lmat.h)
Library Netapi32.lib
Archivo DLL Netapi32.dll

Consulte también

AT_ENUM

NetScheduleJobAdd

NetScheduleJobDel

NetScheduleJobGetInfo

Funciones de administración de red

Introducción a la administración de redes

Programar funciones