MethodScript

== lsprintf == === Vital Info === {| style="width: 40%;" cellspacing="1" cellpadding="1" border="1" class="wikitable" |- ! scope="col" width="20%" | ! scope="col" width="80%" | |- ! scope="row" | Name | lsprintf |- ! scope="row" | Returns | string |- ! scope="row" | Usages | locale, formatString, parameters...

---

locale, formatString, array(parameters...) |- ! scope="row" | Throws | [[../objects/ms.lang.FormatException|ms.lang.FormatException]]
[[../objects/ms.lang.InsufficientArgumentsException|ms.lang.InsufficientArgumentsException]]
[[../objects/ms.lang.CastException|ms.lang.CastException]] |- ! scope="row" | Since | 3.3.1 |- ! scope="row" | Restricted | |- ! scope="row" | Optimizations | [[../../Optimizer#CONSTANT_OFFLINE|CONSTANT_OFFLINE]]
[[../../Optimizer#OPTIMIZE_DYNAMIC|OPTIMIZE_DYNAMIC]] |} === Usages ===

lsprintf(locale, formatString, parameters...)

lsprintf(locale, formatString, array(parameters...))

=== Examples === ====Example 1==== Basic usage Given the following code: The output would be:

:1

====Example 2==== Multiple arguments Given the following code: The output would be:

:12

====Example 3==== Multiple arguments in an array Given the following code: The output would be:

:12

====Example 4==== Compile error, missing parameters Given the following code: The output might be:

Causes compile error: The specified format string: "%d" expects 1 argument(s), but 0 were provided.

====Example 5==== Other formatting: float with precision (using integer) Given the following code: The output would be:

:004.000

====Example 6==== Other formatting: float with precision (with rounding) Given the following code: The output would be:

:003.457

====Example 7==== Other formatting: float with precision in a different locale (with rounding) Given the following code: The output would be:

:003,457

====Example 8==== Other formatting: time Given the following code: The output might be:

:06 13,2013

====Example 9==== Literal percent sign Given the following code: The output might be:

%

====Example 10==== Hexidecimal formatting Given the following code: The output would be:

:f

====Example 11==== Other formatting: character Given the following code: The output would be:

:s

====Example 12==== Other formatting: character (with capitalization) Given the following code: The output would be:

:S

====Example 13==== Other formatting: scientific notation Given the following code: The output would be:

:2.345000e+03

====Example 14==== Other formatting: plain string Given the following code: The output would be:

:plain string

====Example 15==== Other formatting: boolean Given the following code: The output would be:

:true

====Example 16==== Other formatting: boolean (with capitalization) Given the following code: The output would be:

:FALSE

====Example 17==== Other formatting: hash code Given the following code: The output would be:

:7c4711dc

===See Also=== [[API/functions/sprintf.html|sprintf]], [[API/functions/get_locales.html|get_locales]]

Find a bug in this page? Edit this page yourself, then submit a pull request. (Note this page is automatically generated from the documentation in the source code.)