通过

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 Professional [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 mstask.h
Library Mstask.lib
DLL Mstask.dll
可再发行组件 Windows NT 4.0 和 Windows 95 上的 Internet Explorer 4.0 或更高版本

另请参阅

IScheduledWorkItem

ITask