Return the non‐modifiable value associated with the specified user‐data key.
Synopsis
Declared in <balm_metricdescription.h>
void const*
userData(UserDataKey key) const;Description
If the data for key has not been set, a value of 0 is returned, which is indistinguishable from a valid key with a 0 value. The behavior is undefined unless key >= 0. Note that this method allows clients of balm to access the (opaque) application‐specific information that they have previously associated with a metric (via setUserData).
Return Value
opaque user‐data value for key, or 0 if unset
Parameters
Name |
Description |
key |
user‐data key associated with this metric |
Created with MrDocs