[#BloombergLP-bdlcc-StripedUnorderedMultiMap-visit-09]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlcc.adoc[bdlcc]::xref:BloombergLP/bdlcc/StripedUnorderedMultiMap.adoc[StripedUnorderedMultiMap]::visit
:relfileprefix: ../../../
:mrdocs:

Call `visitor` on each element matching `key` until it returns false.

== Synopsis

Declared in `<bdlcc_stripedunorderedmultimap.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
visit(
    KEY const& key,
    xref:BloombergLP/bdlcc/StripedUnorderedMultiMap/VisitorFunction.adoc[VisitorFunction] const& visitor);
----

== Description

Serially call the specified `visitor` on each element (if one exists) in this hash map having the specified `key` until every such element has been updated or `visitor` returns `false`. 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 exclusive access (i.e., write access) to each element for duration of each invocation. The behavior is undefined if hash map manipulators and `getValue*` methods are invoked from within `visitor`, as it may lead to a deadlock.

== Return Value

number of elements visited, or its negation if stopped early

== Parameters

[cols="1,4"]
|===
| Name| Description
| *key*
| key of the elements to visit
| *visitor*
| functor invoked with each matching value
|===


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