NetScheduleJobEnum, fonction (lmat.h)

Article
08/24/2023

[NetScheduleJobEnum n’est plus disponible à partir de Windows 8. Utilisez plutôt les interfaces Du planificateur de tâches 2.0.

]

La fonction NetScheduleJobEnum répertorie les travaux mis en file d’attente sur un ordinateur spécifié. Cette fonction nécessite que le service de planification soit démarré.

Syntaxe

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

Paramètres

[in, optional] Servername

Pointeur vers une chaîne constante qui spécifie le nom DNS ou NetBIOS du serveur distant sur lequel la fonction doit s’exécuter. Si ce paramètre a la valeur NULL, l’ordinateur local est utilisé.

[out] PointerToBuffer

Pointeur vers la mémoire tampon qui reçoit les données. Les informations de retour sont un tableau de structures AT_ENUM . La mémoire tampon est allouée par le système et doit être libérée à l’aide d’un seul appel à la fonction NetApiBufferFree . Notez que vous devez libérer la mémoire tampon même si la fonction échoue avec ERROR_MORE_DATA.

[in] PrefferedMaximumLength

Valeur qui indique la longueur maximale préférée des données retournées, en octets. Si vous spécifiez MAX_PREFERRED_LENGTH, la fonction alloue la quantité de mémoire requise pour les données. Si vous spécifiez une autre valeur dans ce paramètre, cela peut limiter le nombre d’octets retournés par la fonction. Si la taille de la mémoire tampon est insuffisante pour contenir toutes les entrées, la fonction retourne ERROR_MORE_DATA. Pour plus d’informations, consultez Mémoires tampons de fonction de gestion réseau et Longueurs de mémoire tampon des fonctions de gestion réseau.

[out] EntriesRead

Pointeur vers une valeur qui reçoit le nombre d’éléments réellement énumérés.

[out] TotalEntries

Pointeur vers une valeur qui reçoit le nombre total d’entrées qui auraient pu être énumérées à partir de la position actuelle du CV. Notez que les applications doivent considérer cette valeur uniquement comme un indicateur.

[in, out] ResumeHandle

Pointeur vers une valeur qui contient un handle de CV utilisé pour continuer une énumération de travail. Le handle doit être égal à zéro lors du premier appel et rester inchangé pour les appels suivants. Si ce paramètre a la valeur NULL, aucun handle de reprise n’est stocké.

Valeur retournée

Si la fonction réussit, la valeur de retour est NERR_Success.

Si la fonction échoue, la valeur de retour est un code d’erreur système. Pour obtenir la liste des codes d’erreur, consultez Codes d’erreur système.

Remarques

Normalement, seuls les membres du groupe Administrateurs local sur l’ordinateur sur lequel le travail de planification est énuméré peuvent exécuter correctement cette fonction. Si le nom du serveur transmis dans la chaîne pointée vers par le paramètre Servername est un serveur distant, seuls les membres du groupe Administrateurs local sur le serveur peuvent exécuter cette fonction avec succès.

Si la valeur de Registre suivante a l’ensemble de bits le moins significatif (par exemple, 0x00000001), les utilisateurs appartenant au groupe Opérateurs de serveur peuvent également exécuter correctement cette fonction.

HKLM\System\CurrentControlSet\Control\Lsa\SubmitControl

Chaque entrée retournée contient une structure AT_ENUM . La valeur du membre JobId peut être utilisée lors de l’appel de fonctions qui nécessitent un paramètre d’identificateur de travail, comme la fonction NetScheduleJobDel .

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	lmat.h (inclure Lmat.h)
Bibliothèque	Netapi32.lib
DLL	Netapi32.dll