aclrtDestroyStream

Description

Destroys a stream created by the aclrtCreateStream, aclrtCreateStreamWithConfig, or aclrtCreateStreamV2 call. If there are unfinished tasks on the stream, the stream is destroyed after the tasks are complete.

Restrictions

  • Before calling aclrtDestroyStream to destroy a specified stream, call aclrtSynchronizeStream to ensure that all tasks in the stream are complete.
  • When calling aclrtDestroyStream to destroy a specified stream, ensure that the stream is in the current context.
  • The stream passed to the aclrtDestroyStream call must not be in use by other API calls.

Prototype

aclError aclrtDestroyStream(aclrtStream stream)

Parameters

Parameter

Input/Output

Description

stream

Input

Stream to destroy.

Returns

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

See Also

For details about the API call sequence and example, see Runtime Resource Allocation and Deallocation.