diff options
| author | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
| commit | 754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 (patch) | |
| tree | f1190704f78f04a2b0b4c977d20fe96a828377f1 /devdocs/c/atomic%2Fatomic_flag_clear.html | |
new repository
Diffstat (limited to 'devdocs/c/atomic%2Fatomic_flag_clear.html')
| -rw-r--r-- | devdocs/c/atomic%2Fatomic_flag_clear.html | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/devdocs/c/atomic%2Fatomic_flag_clear.html b/devdocs/c/atomic%2Fatomic_flag_clear.html new file mode 100644 index 00000000..a9afc72a --- /dev/null +++ b/devdocs/c/atomic%2Fatomic_flag_clear.html @@ -0,0 +1,22 @@ + <h1 id="firstHeading" class="firstHeading">atomic_flag_clear, atomic_flag_clear_explicit</h1> <table class="t-dcl-begin"> <tr class="t-dsc-header"> <th> Defined in header <code><stdatomic.h></code> </th> <th> </th> <th> </th> </tr> <tr class="t-dcl t-since-c11"> <td> <pre data-language="c">void atomic_flag_clear( volatile atomic_flag* obj );</pre> +</td> <td> (1) </td> <td> <span class="t-mark-rev t-since-c11">(since C11)</span> </td> </tr> <tr class="t-dcl t-since-c11"> <td> <pre data-language="c">void atomic_flag_clear_explicit( volatile atomic_flag* obj, memory_order order );</pre> +</td> <td> (2) </td> <td> <span class="t-mark-rev t-since-c11">(since C11)</span> </td> </tr> </table> <p>Atomically changes the state of a <code>atomic_flag</code> pointed to by <code>obj</code> to clear (<code>false</code>). The first version orders memory accesses according to <code><a href="memory_order" title="c/atomic/memory order">memory_order_seq_cst</a></code>, the second version orders memory accesses according to <code>order</code>.</p> +<p>The argument is pointer to a volatile atomic flag to accept addresses of both non-volatile and <a href="../language/volatile" title="c/language/volatile">volatile</a> (e.g. memory-mapped I/O) atomic flags.</p> +<h3 id="Parameters"> Parameters</h3> <table class="t-par-begin"> <tr class="t-par"> <td> obj </td> <td> - </td> <td> pointer to the atomic flag object to modify </td> +</tr> <tr class="t-par"> <td> order </td> <td> - </td> <td> the memory synchronization ordering for this operation: all values are permitted </td> +</tr> +</table> <h3 id="Return_value"> Return value</h3> <p>(none)</p> +<h3 id="References"> References</h3> <ul> +<li> C17 standard (ISO/IEC 9899:2018): </li> +<ul><li> 7.17.8.2 The atomic_flag_clear functions (p: 209) </li></ul> +<li> C11 standard (ISO/IEC 9899:2011): </li> +<ul><li> 7.17.8.2 The atomic_flag_clear functions (p: 286) </li></ul> +</ul> <h3 id="See_also"> See also</h3> <table class="t-dsc-begin"> <tr class="t-dsc"> <td> <div><a href="atomic_flag_test_and_set" title="c/atomic/atomic flag test and set"> <span class="t-lines"><span>atomic_flag_test_and_set</span><span>atomic_flag_test_and_set_explicit</span></span></a></div> +<div><span class="t-lines"><span><span class="t-mark-rev t-since-c11">(C11)</span></span></span></div> </td> <td> sets an atomic_flag to true and returns the old value <br> <span class="t-mark">(function)</span> </td> +</tr> <tr class="t-dsc"> <td colspan="2"> <span><a href="https://en.cppreference.com/w/cpp/atomic/atomic_flag_clear" title="cpp/atomic/atomic flag clear">C++ documentation</a></span> for <code>atomic_flag_clear, atomic_flag_clear_explicit</code> </td> +</tr> </table> <div class="_attribution"> + <p class="_attribution-p"> + © cppreference.com<br>Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.<br> + <a href="https://en.cppreference.com/w/c/atomic/atomic_flag_clear" class="_attribution-link">https://en.cppreference.com/w/c/atomic/atomic_flag_clear</a> + </p> +</div> |