Função NetScheduleJobEnum (lmat.h)

Artigo
02/28/2024

[NetScheduleJobEnum não está mais disponível para uso a partir de Windows 8. Em vez disso, use as Interfaces do Agendador de Tarefas 2.0.

]

A função NetScheduleJobEnum lista os trabalhos enfileirados em um computador especificado. Essa função exige que o serviço de agendamento seja iniciado.

Sintaxe

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

Um ponteiro para uma cadeia de caracteres constante que especifica o nome DNS ou NetBIOS do servidor remoto no qual a função deve ser executada. Se esse parâmetro for NULL, o computador local será usado.

[out] PointerToBuffer

Um ponteiro para o buffer que recebe os dados. As informações de retorno são uma matriz de estruturas AT_ENUM . O buffer é alocado pelo sistema e deve ser liberado usando uma única chamada para a função NetApiBufferFree . Observe que você deve liberar o buffer mesmo que a função falhe com ERROR_MORE_DATA.

[in] PrefferedMaximumLength

Um valor que indica o comprimento máximo preferencial dos dados retornados, em bytes. Se você especificar MAX_PREFERRED_LENGTH, a função alocará a quantidade de memória necessária para os dados. Se você especificar outro valor nesse parâmetro, ele poderá restringir o número de bytes retornados pela função. Se o tamanho do buffer for insuficiente para manter todas as entradas, a função retornará ERROR_MORE_DATA. Para obter mais informações, consulte Buffers de função de gerenciamento de rede e Comprimentos de buffer de função de gerenciamento de rede.

[out] EntriesRead

Um ponteiro para um valor que recebe a contagem de elementos realmente enumerados.

[out] TotalEntries

Um ponteiro para um valor que recebe o número total de entradas que poderiam ter sido enumeradas da posição de currículo atual. Observe que os aplicativos devem considerar esse valor apenas como uma dica.

[in, out] ResumeHandle

Um ponteiro para um valor que contém um identificador de currículo que é usado para continuar uma enumeração de trabalho. O identificador deve ser zero na primeira chamada e deixado inalterado para chamadas subsequentes. Se esse parâmetro for NULL, nenhum identificador de retomada será armazenado.

Retornar valor

Se a função for bem-sucedida, o valor retornado será NERR_Success.

Se a função falhar, o valor retornado será um código de erro do sistema. Para obter uma lista de códigos de erro, consulte Códigos de erro do sistema.

Comentários

Normalmente, somente os membros do grupo administradores locais no computador em que o trabalho de agendamento está sendo enumerado podem executar essa função com êxito. Se o nome do servidor passado na cadeia de caracteres apontada pelo parâmetro Servername for um servidor remoto, somente os membros do grupo administradores local no servidor poderão executar essa função com êxito.

Se o valor do Registro a seguir tiver o conjunto de bits menos significativo (por exemplo, 0x00000001), os usuários pertencentes ao grupo Operadores de Servidor também poderão executar essa função com êxito.

HKLM\System\CurrentControlSet\Control\Lsa\SubmitControl

Cada entrada retornada contém uma estrutura AT_ENUM . O valor do membro JobId pode ser usado ao chamar funções que exigem um parâmetro de identificador de trabalho, como a função NetScheduleJobDel .

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	lmat.h (inclua Lmat.h)
Biblioteca	Netapi32.lib
DLL	Netapi32.dll