[#BloombergLP-balm-MetricRegistry-createUserDataKey]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balm.adoc[balm]::xref:BloombergLP/balm/MetricRegistry.adoc[MetricRegistry]::createUserDataKey
:relfileprefix: ../../../
:mrdocs:

Return a new unique key for associating user data with metrics&period;

== Synopsis

Declared in `&lt;balm&lowbar;metricregistry&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:BloombergLP/balm/MetricDescription/UserDataKey.adoc[MetricDescription::UserDataKey]
createUserDataKey();
----

== Description

Return a new unique key that can be used to associate (via `setUserData`) and retrieve (via `userData`) a value with a metric (or group of metrics)&period; Note that the returned key can be used by clients of `balm` to associate additional information with a metric&period;

== Return Value

a new unique key for associating user data with metrics


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