[#llvm-format_decimal]
= xref:llvm.adoc[llvm]::format_decimal
:relfileprefix: ../
:mrdocs:

Output `N` as a right‐justified, fixed‐width decimal.

== Synopsis

Declared in `<llvm/Support/Format.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:llvm/FormattedNumber.adoc[FormattedNumber]
format_decimal(
    int64_t N,
    unsigned int Width);
----

== Description

If the number will not fit in `Width,` the full number is still printed. Examples: OS << format_decimal(0, 5) => " 0" OS << format_decimal(255, 5) => " 255" OS << format_decimal(‐1, 3) => " ‐1" OS << format_decimal(12345, 3) => "12345"

== Return Value

A formatted number that prints `N` as a fixed‐width decimal.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *N*
| Value to format.
| *Width*
| Minimum field width in characters.
|===


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