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

Conditionally swap `atomicPtr` with sequential consistency.

== Synopsis

Declared in `<bsls_atomicoperations.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
void*
testAndSwapPtr(
    xref:BloombergLP/bsls/Atomic_TypeTraits-0b/Pointer.adoc[AtomicTypes::Pointer]* atomicPtr,
    void* compareValue,
    void* swapValue);
----

== Description

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

== Return Value

initial value of `atomicPtr` before the operation

== Parameters

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


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