[#BloombergLP-bdlde-Utf8Util-ErrorStatus]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlde.adoc[bdlde]::xref:BloombergLP/bdlde/Utf8Util.adoc[Utf8Util]::ErrorStatus
:relfileprefix: ../../../
:mrdocs:

Negative status codes returned when UTF&hyphen;8 validation fails&period;

== Synopsis

Declared in `&lt;bdlde&lowbar;utf8util&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
enum ErrorStatus;
----

== Description

Enumerate the error status values that are returned (possibly through an out parameter) from some methods in this utility&period; Note that some of the functions in this `struct` have a return value that is non&hyphen;negative on success, and one of these values when an error occurs, so all of these values must be negative to distinguish them from a &quot;success&quot; value&period;

== Members

[cols="1,4"]
|===
| Name| Description
| `k&lowbar;END&lowbar;OF&lowbar;INPUT&lowbar;TRUNCATION` 
| End of input was reached partway through a multibyte UTF&hyphen;8 sequence&period;
| `k&lowbar;UNEXPECTED&lowbar;CONTINUATION&lowbar;OCTET` 
| End of input was reached partway through a multibyte UTF&hyphen;8 sequence&period;
| `k&lowbar;NON&lowbar;CONTINUATION&lowbar;OCTET` 
| A non&hyphen;continuation byte was expected but not found&period;
| `k&lowbar;OVERLONG&lowbar;ENCODING` 
| The encoded Unicode value could have been encoded in fewer bytes&period;
| `k&lowbar;INVALID&lowbar;INITIAL&lowbar;OCTET` 
| A sequence began with an octet with its 5 highest&hyphen;order bits all set, which is always invalid in UTF&hyphen;8&period;
| `k&lowbar;VALUE&lowbar;LARGER&lowbar;THAN&lowbar;0X10FFFF` 
| A sequence began with an octet with its 5 highest&hyphen;order bits all set, which is always invalid in UTF&hyphen;8&period;
| `k&lowbar;SURROGATE` 
| Illegal occurrence of Unicode code point reserved for surrogate values in UTF&hyphen;16&period; Note that all surrogate values are illegal as Unicode code points&period;
|===



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