Méthode IScheduledWorkItem ::D eleteTrigger (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 .] ]

Supprime un déclencheur d’un élément de travail.

Syntaxe

HRESULT DeleteTrigger(
  [in] WORD iTrigger
);

Paramètres

[in] iTrigger

Valeur d’index de déclencheur qui spécifie le déclencheur à supprimer. Pour plus d'informations, consultez la section Notes.

Valeur retournée

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

Code de retour Description
S_OK
 L'opération a réussi.
E_INVALIDARG
 Les arguments ne sont pas valides.
E_OUTOFMEMORY
 Mémoire disponible insuffisante.

Remarques

Un index de déclencheur est créé pour chaque déclencheur lors de la création du déclencheur. Toutefois, il ne s’agit pas d’un identificateur unique pour un déclencheur spécifique. Par exemple, si vous créez quatre déclencheurs, ils seront numérotés de 0 à 3. Toutefois, si le deuxième déclencheur est supprimé, les déclencheurs restants sont numérotés de 0 à 2. Notez que l’index du premier déclencheur est toujours égal à 0 et que l’index du dernier déclencheur est inférieur au nombre total de déclencheurs pour l’élément de travail (TriggerCount -1).

Vous pouvez récupérer le nombre de déclencheurs à l’aide de IScheduledWorkItem ::GetTriggerCount.

Pour terminer la suppression du déclencheur, les programmes doivent appeler la méthode IPersistFile ::Save après avoir appelé DeleteTrigger. L’appel de IPersistFile ::Save enregistre les modifications apportées au disque.

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

CreateTrigger

IScheduledWorkItem

IScheduledWorkItem ::GetTriggerCount