Documentation Home >> Headers >> <atomic> Header >> std::atomic >> std::atomic::load member function

Atomically load the current value of the std::atomic instance.

BaseType load(
    memory_order order = memory_order_seq_cst)
    const volatile;

Preconditions:

The supplied order must be one of std::memory_order_relaxed, std::memory_order_acquire, std::memory_order_consume or std::memory_order_seq_cst

Effects:

Atomically loads the value stored in *this.

Returns:

The value stored in *this at the point of the call.

Throws:

Nothing.

Note:

This is an atomic load operation for the memory location comprising *this.

Header

#include <atomic>

See Also