ITaskTrigger ::SetTrigger, méthode (mstask.h)

Article
03/04/2024

[[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 SetTrigger définit les critères de déclencheur pour un déclencheur de tâche.

Syntaxe

HRESULT SetTrigger(
  [in] const PTASK_TRIGGER pTrigger
);

Paramètres

[in] pTrigger

Pointeur vers une structure TASK_TRIGGER qui contient les valeurs qui définissent le nouveau déclencheur de tâche.

Valeur retournée

La méthode SetTrigger 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

Les membres wBeginDay, wBeginMonth et wBeginYear de la structure TASK_TRIGGER doivent être définis sur un jour, un mois et une année valides, respectivement.

Un nombre quelconque de déclencheurs peut être associé à une tâche. Les heures d’exécution de la tâche correspondent à l’union de tous les déclencheurs définis pour cette tâche.

Pour mettre à jour la tâche avec ces nouveaux paramètres de déclencheur, les applications doivent appeler la méthode IPersistFile ::Save après avoir appelé SetTrigger.

Exemples

Le code suivant montre la déclaration de variable et la syntaxe d’appel pour cette méthode, y compris les membres requis de TASK_TRIGGER. Définition des critères de déclencheur lors de la création d’un déclencheur, consultez Création d’un déclencheur.

HRESULT hr = S_OK;

TASK_TRIGGER Trigger;

ZeroMemory(&Trigger, sizeof(TASK_TRIGGER));

Trigger.cbTriggerSize = sizeof(TASK_TRIGGER);
Trigger.wBeginDay = 1;
Trigger.wBeginMonth = 1;
Trigger.wBeginYear = 1999;

// pITaskTrigger is a previously assigned ITaskTrigger pointer.
hr = pITaskTrigger->SetTrigger(&Trigger);
if (FAILED(hr))
{
   printf("Failed SetTrigger\n");
   exit(1);
}

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