# std::atomic_flag::test

> C++ Atlas: `cppatlas.com/w/cpp/atomic/atomic_flag/test` | Source: https://en.cppreference.com/w/cpp/atomic/atomic_flag/test | Domain: atomic | Standards: C++20

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

## Official Specification Summary (cppreference)

```cpp
bool test( std::memory_order order =
               std::memory_order_seq_cst ) const volatile noexcept; // (1) (since C++20)

bool test( std::memory_order order =
               std::memory_order_seq_cst ) const noexcept; // (2) (since C++20)
```

Atomically reads the value of the `*this` and returns the value.

If `order` is one of `std::memory_order_release` and `std::memory_order_acq_rel`, the behavior is undefined.

### Parameters

- `order` - the memory synchronization ordering

### Return value

The value atomically read.

### Example

> Note: This section is incomplete Reason: no example

### See also

- [`atomic_flag_test`](https://en.cppreference.com/w/cpp/atomic/atomic_flag_test) (C++20), [`atomic_flag_test_explicit`](https://en.cppreference.com/w/cpp/atomic/atomic_flag_test) (C++20): atomically returns the value of the flag (function)

---
Attribution: content from https://en.cppreference.com/w/cpp/atomic/atomic_flag/test (cppreference.com), licensed under CC-BY-SA 3.0 and GFDL. Modified: converted to markdown, study notes added. Offline snapshot of 9 February 2025.