[#absl-Status-ToString]
= xref:absl.adoc[absl]::xref:absl/Status.adoc[Status]::ToString
:relfileprefix: ../../
:mrdocs:

Returns a string based on the `mode`&period;

== Synopsis

Declared in `&lt;absl&sol;status&sol;status&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::string
ToString(xref:absl/StatusToStringMode.adoc[StatusToStringMode] mode = StatusToStringMode&colon;&colon;kDefault) const;
----

== Description

By default, it returns combination of the error code name, the message and any associated payload messages&period; This string is designed simply to be human readable and its exact format should not be load bearing&period; Do not depend on the exact format of the result of `ToString()` which is subject to change&period;

The printed code name and the message are generally substrings of the result, and the payloads to be printed use the status payload printer mechanism (which is internal)&period;

== Return Value

A human&hyphen;readable representation of the status&period;

== Parameters

[cols="1,4"]
|===
| Name| Description
| *mode*
| Controls which extra data is included in the output&period;
|===


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