aclrtDeviceTaskAbort

This API is reserved and is not supported currently.

Description

Stops the task that are 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

aclError aclrtDeviceTaskAbort(int32_t deviceId, uint32_t timeout);

Command-Line Options

Parameter

Input/Output

Description

deviceId

Input

Device ID.

The value must be the same as the value of Device ID in aclrtSetDevice.

timeout

Input

Timeout interval.

The options are as follows:

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

Returns

The value 0 indicates success, and other values indicate failure. For details, see aclError.