IRegisteredTask::Run 方法(taskschd.h)
立即运行已注册的任务。
语法
HRESULT Run(
[in] VARIANT params,
[out, optional] IRunningTask **ppRunningTask
);
参数
[in] params
用作任务操作中的值的参数。 若要不指定任务操作的任何参数值,请将此参数设置为 VT_NULL 或 VT_EMPTY。 否则,可以指定单个 BSTR 值或 BSTR 值的数组。
指定的 BSTR 值与名称配对,并存储为名称/值对。 如果指定单个 BSTR 值,则 Arg0 将是分配给该值的名称。 该值可用于在操作属性中使用 $(Arg0) 变量的任务操作。
如果将“0”、“100”和“250”等值传入为 BSTR 值的数组,则“0”将替换 $(Arg0) 变量,“100”将替换 $(Arg1) 变量,而“250”将替换操作属性中使用的 $(Arg2) 变量。
最多可以指定 32 BSTR 值。
有关详细信息以及可以使用 $(Arg0)、$(Arg1)、...、$(Arg32) 变量的值的操作属性列表,请参阅 任务操作。
[out, optional] ppRunningTask
IRunningTask 接口,用于定义任务的新实例。
传入对 NULLIRunningTask 接口指针的引用。 引用非NULL 指针可能会导致内存泄漏,因为该指针将被覆盖。
返回值
如果此方法成功,则返回 S_OK。 否则,它将返回 HRESULT 错误代码。
言论
如果 iTaskSettings 的 AllowDemandStart 属性设置为 false,此方法将返回且不会运行该任务。
IRegisteredTask::Run 函数等效于 IRegisteredTask::RunEx 函数,标志参数等于 0,用户参数等于 NULL。
如果从禁用的任务调用 IRegisteredTask::Run,它将返回SCHED_E_TASK_DISABLED。
要求
要求 | 价值 |
---|---|
最低支持的客户端 | Windows Vista [仅限桌面应用] |
支持的最低服务器 | Windows Server 2008 [仅限桌面应用] |
目标平台 | 窗户 |
标头 | taskschd.h |
库 | Taskschd.lib |
DLL | Taskschd.dll |