Associate value with key on metricId's description.

Synopsis

Declared in <balm_metricregistry.h>

void
setUserData(
    MetricId const& metricId,
    MetricDescription::UserDataKey key,
    void const* value);

Description

Associate the specified value with the specified key in the description of the specified metricId. The behavior is undefined unless key was previously returned from createUserDataKey. Note that this method allows clients of balm to associate (opaque) application‐specific information with a metric.

Parameters

Name

Description

metricId

metric whose user data is set

key

user‐data key previously obtained from createUserDataKey

value

opaque user‐data value to associate

Created with MrDocs