[#util-ErrorString-01]
= xref:util.adoc[util]::ErrorString
:relfileprefix: ../
:mrdocs:

Extracts the error message from a result.

== Synopsis

Declared in `<util/result.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<typename FT>
xref:bilingual_str.adoc[bilingual_str]
ErrorString(xref:util/Result.adoc[Result<FT>] const& result);
----

[NOTE]
====
This function is a https://en.cppreference.com/w/cpp/language/friend[hidden friend] of xref:util/Result.adoc[Result], declared only inside that class: it can be found only through argument-dependent lookup.
====

== Return Value

the stored error message, or an empty string when the result holds a value

== Parameters

[cols="1,4"]
|===
| Name| Description
| *result*
| the result to inspect
|===


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