oms_buffer_max_units_get()
Abstract
Returns the maximum number of units that could be stored in the buffer.
Syntax
oms_buffer_max_units_get (buffer_handle)
| Argument | Type | Description |
|---|---|---|
buffer_handle |
OmsT_Buffer_Handle |
buffer object to query |
Return Type
double
Maximum number of units that could be stored in the buffer.
Details
This function returns the maximum number of units that could be stored in the buffer. A value of OmsC_Buffer_Infinite is returned if the buffer has infinite capacity.
Note that the actual number of units that can be stored is also constrained by the parent pools and what is stored in other buffers in these pools. Therefore, the value returned by this function is really an upper bound.