[#mp_units-unit_symbol_to]
= xref:mp_units.adoc[mp_units]::unit_symbol_to
:relfileprefix: ../
:mrdocs:

Writes the textual symbol of a unit to an output iterator

== Synopsis

Declared in `<mp‐units/framework/unit_text.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    typename CharT = char,
    std::output_iterator<CharT> Out,
    xref:mp_units/Unit.adoc[Unit] U>
constexpr
Out
unit_symbol_to(
    Out out,
    U u,
    xref:mp_units/unit_symbol_formatting.adoc[unit_symbol_formatting] const& fmt = unit_symbol_formatting{});
----

== Return Value

an iterator past the last character written

== Template Parameters

[cols="1,4"]
|===
| Name| Description
| *CharT*
| the character type used to represent the symbol
|===

== Parameters

[cols="1,4"]
|===
| Name| Description
| *out*
| the output iterator to write the symbol to
| *u*
| the unit to obtain the symbol of
| *fmt*
| the formatting options to use
|===


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