Return a new unique key for associating user data with metrics.

Synopsis

Declared in <balm_configurationutil.h>

static
MetricDescription::UserDataKey
createUserDataKey(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). 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, then an unspecified integer value is returned. Note that the returned key can be used by clients of balm to associate additional information with a metric.

Return Value

a new unique user‐data key, or an unspecified value if manager is 0 and the default metrics manager has not been initialized

Parameters

Name

Description

manager

metrics manager to configure; 0 uses the default

Created with MrDocs