cpp / latest / atomic / atomic / load.html

std::atomic<T>::load

T load( std::memory_order order
            = std::memory_order_seq_cst ) const noexcept;
(1) (since C++11)
T load( std::memory_order order
            = std::memory_order_seq_cst ) const volatile noexcept;
(2) (since C++11)

Atomically loads and returns the current value of the atomic variable. Memory is affected according to the value of order.

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

It is deprecated if std::atomic<T>::is_always_lock_free is false and overload (2) participates in overload resolution.

(since C++20)

Parameters

order - memory order constraints to enforce

Return value

The current value of the atomic variable.

See also

loads a value from an atomic object
(public member function)
(C++11)(C++11)
atomically obtains the value stored in an atomic object
(function template)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/atomic/atomic/load