cancelTask()

名称

cancelTask - 取消任务。

语法

db.cancelTask( , [isAsync] )

类别

Sdb

描述

取消任务。

参数

  • id ( Int32， 必填 )

    任务ID。

  • isAsync ( Bool， 选填 )

    是否异步。

返回值

成功：返回新集合的对象。

失败：抛出异常。

错误

cancelTask()函数常见异常如下：

错误码错误类型描述解决方法
-173SDB_CAT_TASK_NOTFOUND任务不存在使用listTasks()检查任务是否存在

当异常抛出时，可以通过getLastError()获取错误码， 或通过getLastErrMsg()获取错误信息。 可以参考常见错误处理指南了解更多内容。

版本

v1.2及以上版本。

示例

  1. 停止切分任务。

    1. > var taskid1 = db.foo.bar.splitAsync( "group1", "group2", 50 );
    2. > db.cancelTask( taskid1, true )