[#mp_units-dimension_symbol]
= xref:mp_units.adoc[mp&lowbar;units]::dimension&lowbar;symbol
:relfileprefix: ../
:mrdocs:

Returns the textual symbol of a dimension as a `std&colon;&colon;basic&lowbar;string&lowbar;view`&period;

== Synopsis

Declared in `&lt;mp&hyphen;units&sol;framework&sol;dimension&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;
    xref:mp_units/dimension_symbol_formatting.adoc[dimension&lowbar;symbol&lowbar;formatting] fmt = dimension&lowbar;symbol&lowbar;formatting&lcub;&rcub;,
    typename CharT = char,
    xref:mp_units/Dimension.adoc[Dimension] D&gt;
&lsqb;&lsqb;nodiscard&rsqb;&rsqb;
consteval
std::basic&lowbar;string&lowbar;view&lt;CharT&gt;
dimension&lowbar;symbol(D d);
----

== Return Value

a view of the dimension&apos;s symbol

[NOTE]
====
The return value https://en.cppreference.com/cpp/language/attributes/nodiscard[should not be discarded^].
====
== Template Parameters

[cols="1,4"]
|===
| Name| Description
| *fmt*
| the formatting options to use
| *CharT*
| the character type of the returned symbol
|===

== Parameters

[cols="1,4"]
|===
| Name| Description
| *d*
| the dimension to render
|===


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