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

Returns the textual symbol of a dimension as a `std::basic_string_view`.

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    xref:mp_units/dimension_symbol_formatting.adoc[dimension_symbol_formatting] fmt = dimension_symbol_formatting{},
    typename CharT = char,
    xref:mp_units/Dimension.adoc[Dimension] D>
[[nodiscard]]
consteval
std::basic_string_view<CharT>
dimension_symbol(D d);
----

== Return Value

a view of the dimension'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]#