[#BloombergLP-bdlcc-StripedUnorderedMap-visitReadOnly-05]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlcc.adoc[bdlcc]::xref:BloombergLP/bdlcc/StripedUnorderedMap.adoc[StripedUnorderedMap]::visitReadOnly
:relfileprefix: ../../../
:mrdocs:

Call read‐only `visitor` on every element until finished or it returns false.

== Synopsis

Declared in `<bdlcc_stripedunorderedmap.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
visitReadOnly(xref:BloombergLP/bdlcc/StripedUnorderedMap/ReadOnlyVisitorFunction.adoc[ReadOnlyVisitorFunction] const& visitor) const;
----

== Description

That is, for `(key, value)`, invoke: ` bool visitor(value, key); ` Return the number of elements visited or the negation of that value if visitations stopped because `visitor` returned `false`. `visitor` has read‐only access to each element for duration of each invocation. Every element present in this hash map at the time `visit` is invoked will be visited unless it is removed before `visitor` is called for that element. Each visitation is done by the calling thread and the order of visitation is not specified. The behavior is undefined if hash map manipulators are invoked from within `visitor`, as it may lead to a deadlock. Note that `visitor` can _not_ change the value of the visited elements.

== Return Value

number of elements visited, or its negation if stopped early

== Parameters

[cols="1,4"]
|===
| Name| Description
| *visitor*
| read‐only functor invoked with each element
|===


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