std::atomic_flag_test, std::atomic_flag_test_explicit

Header: <atomic>

Atomically reads the value of the *object and returns the value.

# Declarations

bool atomic_flag_test( const volatile std::atomic_flag* object ) noexcept;

(since C++20)

bool atomic_flag_test( const std::atomic_flag* object ) noexcept;

(since C++20)

bool atomic_flag_test_explicit( const volatile std::atomic_flag* object,
std::memory_order order ) noexcept;

(since C++20)

bool atomic_flag_test_explicit( const std::atomic_flag* object,
std::memory_order order ) noexcept;

(since C++20)

# Parameters

• object: pointer to the atomic_flag object to read
• order: the memory synchronization ordering

# Return value

The value atomically read.

# Notes

Feature-test macro Value Std Feature __cpp_lib_atomic_flag_test 201907L (C++20) std::atomic_flag::test

# Example

This section is incompleteReason: no example

# See also

• test