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

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

== Synopsis

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

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

== Description

Return a new unique key that can be used to associate (via `setUserData`) a value with a metric (or group of metrics)&period; Optionally specify a metrics `manager` to configure&period; If `manager` is 0, configure the default metrics manager&semi; if `manager` is 0 and the default metrics manager has not been initialized, then an unspecified integer value is returned&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 user&hyphen;data key, or an unspecified value if `manager` is 0 and the default metrics manager has not been initialized

== Parameters

[cols="1,4"]
|===
| Name| Description
| *manager*
| metrics manager to configure&semi; 0 uses the default
|===


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