Function: device_task_abort

Description

Stops the task that is being executed on a specified device and discards the tasks that have been delivered to the device. This API allows you to set an infinite wait interval or a specific timeout interval. If a specific timeout interval is configured, the API returns an error when the timeout interval is exceeded after this API is called.

Prototype

  • C Prototype
    1
    aclError aclrtDeviceTaskAbort(int32_tdeviceId,uint32_ttimeout);
    
  • Python Function
    1
    ret=acl.rt.device_task_abort(device_id,timeout)
    

Parameters

Parameter

Description

deviceId

Int, device ID. The value must be the same as the device ID in the set_device call.

timeout

Int, timeout interval.

The options are as follows:

  • 0: forever;
  • > 0: specific timeout interval, in ms. The maximum timeout interval is 36 minutes.

Return Value

Return Value

Description

ret

Int, error code. 0 on success; else, failure.

This API is reserved and is not supported currently.