aclrtStreamGetFlags

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

Queries the flag during stream creation.

Prototype

aclError aclrtStreamGetFlags(aclrtStream stream, uint32_t *flags)

Parameters

Parameter	Input/Output	Description
stream	Input	Stream. For details about the type definition, see aclrtStream. If NULL is passed, the flag of the default stream is obtained.
flags	Output	Pointer to the queried flag value. For details about the flag value, see the flag parameter description in the aclrtCreateStreamWithConfig. If multiple flags are configured during stream creation, the return value is the result of the bitwise OR operation on the flags. For example, if 0x01U and 0x02U are configured, 0x03U is returned. If no flag is configured during stream creation, 0 is returned. For the default stream, the flag value may vary with the product model. Use the value queried by calling this API.

Parameter

Input/Output

Description

stream

Input

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

If NULL is passed, the flag of the default stream is obtained.

flags

Output

Pointer to the queried flag value.

For details about the flag value, see the flag parameter description in the aclrtCreateStreamWithConfig. If multiple flags are configured during stream creation, the return value is the result of the bitwise OR operation on the flags. For example, if 0x01U and 0x02U are configured, 0x03U is returned. If no flag is configured during stream creation, 0 is returned.

For the default stream, the flag value may vary with the product model. Use the value queried by calling this API.

Returns

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

Parent topic: Stream Management