IScheduledWorkItem::GetTriggerString-Methode (mstask.h)

[[Diese API kann in nachfolgenden Versionen des Betriebssystems oder Produkts geändert oder nicht verfügbar sein. Verwenden Sie stattdessen die Taskplaner 2.0-Schnittstellen .] ]

Ruft eine Zeichenfolge ab, die den Arbeitselementtrigger beschreibt.

Syntax

HRESULT GetTriggerString(
  [in]  WORD   iTrigger,
  [out] LPWSTR *ppwszTrigger
);

Parameter

[in] iTrigger

Der Index des abzurufenden Triggers. Auf den ersten Trigger wird immer mit 0 verwiesen. Weitere Informationen finden Sie in den Hinweisen.

[out] ppwszTrigger

Ein Zeiger auf eine NULL-Zeichenfolge, die die abgerufene Triggerbeschreibung enthält. Beachten Sie, dass diese Zeichenfolge durch einen Aufruf von CoTaskMemFree freigegeben werden muss, nachdem die Zeichenfolge nicht mehr benötigt wird.

Rückgabewert

Die GetTriggerString-Methode gibt einen der folgenden Werte zurück.

Hinweise

Ein Triggerindex ist kein Bezeichner. Es gibt nur die Position des Triggers relativ zu den aktuellen Triggern an, die dem Arbeitselement zugeordnet sind. Wenn Sie beispielsweise vier Trigger erstellen, werden diese von 0 bis 3 nummeriert. Wenn der zweite Trigger jedoch gelöscht wird, werden die verbleibenden Trigger 0 bis 2 nummeriert. Beachten Sie, dass der Index des ersten Triggers immer 0 ist und der Index des letzten Triggers eins kleiner ist als die Gesamtzahl der Trigger für das Arbeitselement (TriggerCount -1).

Sie können die Triggeranzahl mithilfe von IScheduledWorkItem::GetTriggerCount abrufen.

Beispiele

Ein Beispiel zum Abrufen der Triggerzeichenfolge aller Trigger, die einer Aufgabe zugeordnet sind, finden Sie unter Abrufen von Triggerzeichenfolgenbeispiel.

Anforderungen

Weitere Informationen

IScheduledWorkItem

Itask