View source for API:StatusBarGetMaximumValue

{{LuaApi|group=StatusBar}}
Returns the maximum value of a StatusBar.

<pre>
maximum = StatusBarGetMaximumValue(barName)
</pre>

== Arguments ==
;barName : <code>string</code> – Name of a StatusBar window.

== Returns ==
;maximum : <code>number</code> – The bar's maximum value.

== Details ==
* The maximum is set with [[API:StatusBarSetMaximumValue|StatusBarSetMaximumValue]].
* The error is the same when the window does not exist and when it is not a StatusBar.
* The stock UI never calls <code>StatusBarGetMaximumValue</code>.

== Errors ==
* <code>Error in function call 'StatusBarGetMaximumValue': StatusBar %s does not exist.</code>

== Example ==
A minimal example built from the signature above:
<pre>
local fraction = StatusBarGetCurrentValue( "MyBar" ) / StatusBarGetMaximumValue( "MyBar" )
</pre>

== See also ==
* [[API:StatusBarSetMaximumValue|StatusBarSetMaximumValue]]
* [[API:StatusBarGetCurrentValue|StatusBarGetCurrentValue]]