[#BloombergLP-bdld-Datum-adoptMap-05]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdld.adoc[bdld]::xref:BloombergLP/bdld/Datum.adoc[Datum]::adoptMap
:relfileprefix: ../../../
:mrdocs:

Return a datum that takes ownership of the specified key‐owning `map`.

== Synopsis

Declared in `<bdld_datum.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
xref:BloombergLP/bdld/Datum.adoc[Datum]
adoptMap(xref:BloombergLP/bdld/DatumMutableMapOwningKeysRef.adoc[DatumMutableMapOwningKeysRef] const& map);
----

== Description

Return, by value, a datum that refers to the specified `map`. The behavior is undefined unless `map` was created using `createUninitializedMapOwningKeys` method. The behavior is also undefined unless each element in the held map has been assigned a value and the size of the map has been set accordingly. The behavior is also undefined unless keys have been copied into the map. Note that the adopted map is owned and will be freed if `Datum::destroy` is called on the returned object.

== Return Value

a datum that takes ownership of the specified key‐owning `map`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *map*
| mutable key‐owning map previously created uninitialized
|===


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