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

Retrieves a message's status as a null terminated C string.

== Synopsis

Declared in `<absl/status/status.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
char const*
StatusMessageAsCStr(xref:absl/Status.adoc[Status] const& status);
----

== Description

The lifetime of this string is tied to the lifetime of the status object itself.

If the status's message is empty, the empty string is returned.

StatusMessageAsCStr exists for C support. Use `status.message()` in C++.

== Return Value

A null‐terminated C string for the status message.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *status*
| The status whose message is retrieved.
|===


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