Méthode ITaskScheduler ::AddWorkItem (mstask.h)

  • Article

[[Cette API peut être modifiée ou indisponible dans les versions ultérieures du système d’exploitation ou du produit. Utilisez plutôt les interfaces Du planificateur de tâches 2.0 .] ]

La méthode AddWorkItem ajoute une tâche à la planification des tâches.

Syntaxe

HRESULT AddWorkItem(
  [in] LPCWSTR            pwszTaskName,
  [in] IScheduledWorkItem *pWorkItem
);

Paramètres

[in] pwszTaskName

Chaîne terminée par null qui spécifie le nom de la tâche à ajouter. Le nom de la tâche doit être conforme aux conventions d’affectation de noms de fichiers Windows NT, mais ne peut pas inclure de barres obliques inverses, car l’imbrication dans l’objet dossier de tâches n’est pas autorisée.

[in] pWorkItem

Pointeur vers la tâche à ajouter à la planification.

Valeur retournée

La méthode AddWorkItem retourne l’une des valeurs suivantes.

Code de retour Description
S_OK
 L'opération a réussi.
ERROR_FILE_EXISTS
 Une tâche portant le nom spécifié existe déjà. La valeur de retour réelle est HRESULT_FROM_WIN32(ERROR_FILE_EXISTS).
E_INVALIDARG
 Un ou plusieurs arguments ne sont pas valides.
E_OUTOFMEMORY
 La mémoire n'est pas suffisante pour terminer cette opération.

Remarques

Le planificateur de tâches fournit deux méthodes pour ajouter des éléments de travail : NewWorkItem et AddWorkItem. De ces méthodes, chacune a son avantage spécifique. AddWorkItem empêche les collisions de nommage, mais nécessite également deux opérations d’écriture sur disque par appel. Une opération d’écriture est effectuée lorsque l’appel à AddWorkItem crée un objet d’élément de travail vide sur le disque, suivie d’une autre opération d’écriture lorsque IPersistFile ::Save est appelé.

NewWorkItem n’empêche pas les collisions de nommage, mais il ne nécessite qu’une seule opération d’écriture sur disque lorsque IPersistFile ::Save est appelé. Bien que NewWorkItem soit plus efficace avec les opérations d’écriture sur disque, l’application risque de faire en sorte qu’une autre application crée un élément de travail portant le même nom avant que l’appel à IPersistFile ::Save ne soit effectué.

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 mstask.h
Bibliothèque Mstask.lib
DLL Mstask.dll
Composant redistribuable Internet Explorer 4.0 ou version ultérieure sur Windows NT 4.0 et Windows 95

Voir aussi

IScheduledWorkItem

ITaskScheduler

ITaskScheduler ::NewWorkItem