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

Associate the specified `value` with the specified data `key`.

== Synopsis

Declared in `<balm_metricdescription.h>`

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

== Description

The behavior is undefined unless `key >= 0`. Note that this method allows clients of `balm` to associate (opaque) application‐specific information with a metric.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *key*
| user‐data key associated with this metric
| *value*
| opaque user‐data value to associate
|===


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