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

Associate `value` with `key` on one metric's description.

== Synopsis

Declared in `<balm_configurationutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
void
setUserData(
    char const* category,
    char const* metricName,
    xref:BloombergLP/balm/MetricDescription/UserDataKey.adoc[MetricDescription::UserDataKey] key,
    void const* value,
    xref:BloombergLP/balm/MetricsManager.adoc[MetricsManager]* manager = 0);
----

== Description

Associate the specified `value` with the specified data `key` in the description of the metric having the specified `category` and `metricName`. Optionally specify a metrics `manager` to configure. If `manager` is 0, configure the default metrics manager; if `manager` is 0 and the default metrics manager has not been initialized, this method has no effect. If a `MetricId` does not exist for the `category` and `metricName`, create one and add it to the metric registry of the indicated metrics manager. The behavior is undefined unless `key` was previously created for the indicated metrics manager's metrics registry (e.g., by calling `createUserDataKey`). Note that this method allows clients of `balm` to associate (opaque) application‐specific information with a metric.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *category*
| category of the metric to update
| *metricName*
| name of the metric to update
| *key*
| user‐data key previously obtained from `createUserDataKey`
| *value*
| opaque user‐data value to associate
| *manager*
| metrics manager to configure; 0 uses the default
|===


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