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 函数,其 flags 参数等于 0,user 参数等于 NULL。
如果从已禁用的任务调用 IRegisteredTask::Run ,它将返回SCHED_E_TASK_DISABLED。
要求
最低受支持的客户端 | Windows Vista [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2008 [仅限桌面应用] |
目标平台 | Windows |
标头 | taskschd.h |
Library | Taskschd.lib |
DLL | Taskschd.dll |
另请参阅
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈