IScheduledWorkItem：：GetTriggerString 方法 (mstask.h)

  • 發行項

[[此 API 可能會在後續版本的操作系統或產品中變更或無法使用。 請改用 工作排程器 2.0 介面 。] ]

擷取描述 工作項目 觸發程式的字串。

語法

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

參數

[in] iTrigger

要擷取之觸發程式的索引。 第一個觸發程式一律由0參考。 如需詳細資訊，請參閱＜備註＞。

[out] ppwszTrigger

包含所擷取觸發程式描述之 Null 終止字串的指標。 請注意，在不再需要字串之後，必須呼叫 CoTaskMemFree 來釋放此字串。

傳回值

GetTriggerString 方法會傳回下列其中一個值。

傳回碼 描述
S_OK
 作業成功。
E_INVALIDARG
 自變數無效。
E_OUTOFMEMORY
 記憶體不足。

備註

觸發程式索引不是標識碼。 它只會指出觸發程式相對於與工作專案相關聯之目前觸發程式的位置。 例如，如果您建立四個觸發程式，它們會編號為 0 到 3。 但是，如果刪除第二個觸發程式，剩餘的觸發程式將會編號為 0 到 2。 請注意，第一個觸發程式的索引一律為0，而最後一個觸發程式的索引則小於工作專案 (TriggerCount -1 的觸發程式總數) 。

您可以使用 IScheduledWorkItem：：GetTriggerCount 來擷取觸發程式計數。

範例

如需如何擷取與工作相關聯之所有觸發程式的觸發程式字串的範例，請參閱 擷取觸發程式字串範例。

規格需求

需求 值
最低支援的用戶端 Windows 2000 專業版 [僅限傳統型應用程式]
最低支援的伺服器 Windows 2000 Server [僅限傳統型應用程式]
目標平台 Windows
標頭 mstask.h
程式庫 Mstask.lib
Dll Mstask.dll
可轉散發套件 Windows NT 4.0 和 Windows 95 上的 Internet Explorer 4.0 或更新版本

另請參閱

IScheduledWorkItem

ITask