oms_buffer_statistic_get()
Abstract
Returns whether a given statistic is maintained by the buffer and, if so, the corresponding stat handle.
Syntax
oms_buffer_statistic_get (buffer_handle, statistic_index, statistic_handle_ptr)
| Argument | Type | Description |
|---|---|---|
buffer_handle |
OmsT_Buffer_Handle |
buffer object from which to obtain statistic |
statistic_index |
OmsT_Buffer_Stat_Index |
which statistic to obtain |
statistic_handle_ptr |
Stathandle * |
returned statistic |
Return Type
Boolean
Whether the specified statistic is available for the buffer.
Details
Each buffer can automatically maintain a set of statistics. If a statistic is maintained, the buffer was provided with an appropriate stat handle. This function is used to check if a given statistic is maintained and the corresponding stat handle. For details on which statistics are maintained, see Maintained Statistics.