op_stat_tag_add_dbl()
Abstract
Adds a tag with a double value to a statistic.
Syntax
op_stat_tag_add_dbl (stat_handle, tag_name, value)
| Argument | Type | Description |
|---|---|---|
stat_handle |
Stathandle |
Statistic handle identifying the global or local statistic to be tagged. [A statistic handle can be obtained via the KP op_stat_reg().] |
tag_name |
const char * |
Name of the tag to add to this statistic. |
value |
double |
Value for the tag. |
Return Type
void
No return value.
Example
op_stat_tag_add_dbl (stat_handle, “Bandwidth”, link_bandwidth);
Details
None.
Purpose
Provides a way to assign a tag to a statistic. Statistic tags consist of a name and value pair that is written to the output file along with the statistic. You can assign multiple tags to a statistic. Statistic tags can be used to provide additional details about a statistic and for arranging statistics in the treeview hierarchy of the Results Browser.
Errors
- Recoverable Error: Attempting use of unregistered statistic handle.
Reference
- Use the KP op_stat_tag_add_int32() to assign a tag with a 32-bit integer value
- Use the KP op_stat_tag_add_int64() to assign a tag with a 64-bit integer value
- Use the KP op_stat_tag_add_str() to assign a tag with a string value