aclrtDestroyStream

Applicability

Product

Supported

Atlas 350 Accelerator Card

Atlas A3 training product / Atlas A3 inference product

Atlas A2 training product / Atlas A2 inference product

Atlas 200I/500 A2 inference product

Atlas inference product

Atlas training product

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.

Prototype

1
aclError aclrtDestroyStream(aclrtStream stream)

Parameters

Parameter

Input/Output

Description

stream

Input

Stream to destroy. For details about the type definition, see aclrtStream.

Returns

0 on success; otherwise, failure. For details, see aclError.

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.

API Call Example

For the API call example, see Stream Creation and Destruction.