std::atomic_load, std::atomic_load_explicit - cppreference.com

##### cppreference.com

##### Search

Create account

##### Namespaces

- Page
- Discussion

##### Variants

##### Views

- View
- Edit
- History

##### Actions

# std::atomic_load, std::atomic_load_explicit

From cppreference.com
< cpp‎ | atomic

Defined in header `<atomic>` |  |

| (1) | (since C++11)
template< class T > T atomic_load( const std::atomic<T>* obj ); |  |
template< class T > T atomic_load( const volatile std::atomic<T>* obj ); |  |
| (2) | (since C++11)
template< class T > T atomic_load_explicit( const std::atomic<T>* obj, std::memory_order order ); |  |
template< class T > T atomic_load_explicit( const volatile std::atomic<T>* obj, std::memory_order order ); |  |

1) Atomically obtains the value pointed to by `obj` as if by obj->load()
2) Atomically obtains the value pointed to by `obj` as if by obj->load(order)

### [edit] Parameters

obj | - | pointer to the atomic object to modify
order | - | the memory sycnhronization ordering for this operation: only std::memory_order_relaxed, std::memory_order_consume, std::memory_order_acquire and std::memory_order_seq_cst are permitted.

### [edit] Return value

The value that is held by the atomic object pointed to by `obj`

### [edit] Exceptions

`noexcept` specification:
noexcept

### [edit] See also

load (C++11) | atomically obtains the value of the atomic object (public member function of `std::atomic`) [edit]
atomic_storeatomic_store_explicit (C++11)(C++11) | atomically replaces the value of the atomic object with a non-atomic argument (function template) [edit]
memory_order (C++11) | defines memory ordering constraints for the given atomic operation (typedef) [edit]
std::atomic_load(std::shared_ptr) std::atomic_load_explicit(std::shared_ptr) | specializes atomic operations for std::shared_ptr (function template)
C documentation for atomic_load, atomic_load_explicit

Retrieved from "http://en.cppreference.com/mwiki/index.php?title=cpp/atomic/atomic_load&oldid=67615"
Category:

- unconditionally noexcept