Метод IScheduledWorkItem::GetTriggerString (mstask.h)

[[Этот API может быть изменен или недоступен в последующих версиях операционной системы или продукта. Вместо этого используйте интерфейсы планировщика задач 2.0 .] ]

Извлекает строку, описывающую триггер рабочего элемента .

Синтаксис

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

Параметры

[in] iTrigger

Индекс извлекаемого триггера. На первый триггер всегда ссылается 0. Дополнительные сведения см. в подразделе "Примечания".

[out] ppwszTrigger

Указатель на строку, завершающуюся нулевым значением, которая содержит полученное описание триггера. Обратите внимание, что эта строка должна быть освобождена путем вызова CoTaskMemFree после того, как строка больше не нужна.

Возвращаемое значение

Метод GetTriggerString возвращает одно из следующих значений.

Комментарии

Индекс триггера не является идентификатором. Он указывает только положение триггера относительно текущих триггеров, связанных с рабочим элементом. Например, если создать четыре триггера, они будут нумерованы от 0 до 3. Но если второй триггер удален, остальные триггеры будут нумерованы от 0 до 2. Обратите внимание, что индекс первого триггера всегда равен 0, а индекс последнего триггера на один меньше, чем общее число триггеров для рабочего элемента (TriggerCount -1).

Число триггеров можно получить с помощью IScheduledWorkItem::GetTriggerCount.

Примеры

Пример получения строки триггера всех триггеров, связанных с задачей, см. в разделе Пример получения строк триггера.

Требования

См. также раздел

IScheduledWorkItem

ITask