Méthode IScheduledWorkItem ::GetTriggerString (mstask.h)
[[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 .] ]
Récupère une chaîne qui décrit le déclencheur d’élément de travail .
Syntaxe
HRESULT GetTriggerString(
[in] WORD iTrigger,
[out] LPWSTR *ppwszTrigger
);
Paramètres
[in] iTrigger
Index du déclencheur à récupérer. Le premier déclencheur est toujours référencé par 0. Pour plus d'informations, consultez la section Notes.
[out] ppwszTrigger
Pointeur vers une chaîne terminée par null qui contient la description du déclencheur récupérée. Notez que cette chaîne doit être libéré par un appel à CoTaskMemFree une fois que la chaîne n’est plus nécessaire.
Valeur retournée
La méthode GetTriggerString retourne l’une des valeurs suivantes.
| Code de retour | Description |
|---|---|
|
L'opération a réussi. |
|
Les arguments ne sont pas valides. |
|
Mémoire disponible insuffisante. |
Remarques
Un index de déclencheur n’est pas un identificateur. Elle indique uniquement la position du déclencheur par rapport aux déclencheurs actuels associés à l’élément de travail. 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.
Exemples
Pour obtenir un exemple de récupération de la chaîne de déclencheur de tous les déclencheurs associés à une tâche, consultez Exemple de récupération de chaînes de déclencheur.
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 |