[#BloombergLP-bsls-AtomicOperations-testAndSwapUint]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bsls.adoc[bsls]::xref:BloombergLP/bsls/AtomicOperations.adoc[AtomicOperations]::testAndSwapUint
:relfileprefix: ../../../
:mrdocs:

Conditionally swap `atomicUint` with sequential consistency.

== Synopsis

Declared in `<bsls_atomicoperations.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
unsigned int
testAndSwapUint(
    xref:BloombergLP/bsls/Atomic_TypeTraits-0b/Uint.adoc[AtomicTypes::Uint]* atomicUint,
    unsigned int compareValue,
    unsigned int swapValue);
----

== Description

Conditionally set the value of the specified `atomicUint` to the specified `swapValue` if and only if the value of `atomicUint` equals the value of the specified `compareValue`, and return the initial value of `atomicUint`, providing the sequential consistency memory ordering guarantee. The whole operation is performed atomically.

== Return Value

initial value of `atomicUint` before the operation

== Parameters

[cols="1,4"]
|===
| Name| Description
| *atomicUint*
| atomic unsigned integer to test and possibly update
| *compareValue*
| expected current value of `atomicUint`
| *swapValue*
| value to store if the comparison succeeds
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#