[#BloombergLP-bdldfp-DecimalUtil-format-0d]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdldfp.adoc[bdldfp]::xref:BloombergLP/bdldfp/DecimalUtil.adoc[DecimalUtil]::format
:relfileprefix: ../../../
:mrdocs:

`format` overloads

== Synopses

Declared in `<bdldfp_decimalutil.h>`

Same as the related overload above for `format`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdldfp/DecimalUtil/format-05.adoc[format](
    char* buffer,
    int length,
    xref:BloombergLP/bdldfp/Decimal128.adoc[Decimal128] value,
    xref:BloombergLP/bdldfp/DecimalFormatConfig.adoc[DecimalFormatConfig] const& cfg = DecimalFormatConfig());
----

[.small]#xref:BloombergLP/bdldfp/DecimalUtil/format-05.adoc[_» more..._]#

Format `value` into `buffer` and return the formatted length.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdldfp/DecimalUtil/format-00.adoc[format](
    char* buffer,
    int length,
    xref:BloombergLP/bdldfp/Decimal32.adoc[Decimal32] value,
    xref:BloombergLP/bdldfp/DecimalFormatConfig.adoc[DecimalFormatConfig] const& cfg = DecimalFormatConfig());
----

[.small]#xref:BloombergLP/bdldfp/DecimalUtil/format-00.adoc[_» more..._]#

Same as the overload taking `Decimal32`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdldfp/DecimalUtil/format-0b.adoc[format](
    char* buffer,
    int length,
    xref:BloombergLP/bdldfp/Decimal64.adoc[Decimal64] value,
    xref:BloombergLP/bdldfp/DecimalFormatConfig.adoc[DecimalFormatConfig] const& cfg = DecimalFormatConfig());
----

[.small]#xref:BloombergLP/bdldfp/DecimalUtil/format-0b.adoc[_» more..._]#

== Return Value

length of the formatted value

== Parameters

[cols="1,4"]
|===
| Name| Description
| *buffer*
| buffer that receives the formatted characters
| *length*
| capacity of `buffer` in bytes
| *value*
| decimal value to format
| *cfg*
| optional formatting configuration
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#