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

Enumerate the error status values that are returned (possibly through an out parameter) from some methods in this utility. Note that some of the functions in this `struct` have a return value that is non‐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 "success" value.

== Synopsis

Declared in `<bdlde_utf8util.h>`

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

== Members

[cols="1,4"]
|===
| Name| Description
| `k_END_OF_INPUT_TRUNCATION` 
| End of input was reached partway through a multibyte UTF‐8 sequence.
| `k_UNEXPECTED_CONTINUATION_OCTET` 
| End of input was reached partway through a multibyte UTF‐8 sequence.
| `k_NON_CONTINUATION_OCTET` 
| A non‐continuation byte was expected but not found.
| `k_OVERLONG_ENCODING` 
| The encoded Unicode value could have been encoded in fewer bytes.
| `k_INVALID_INITIAL_OCTET` 
| A sequence began with an octet with its 5 highest‐order bits all set, which is always invalid in UTF‐8.
| `k_VALUE_LARGER_THAN_0X10FFFF` 
| A sequence began with an octet with its 5 highest‐order bits all set, which is always invalid in UTF‐8.
| `k_SURROGATE` 
| Illegal occurrence of Unicode code point reserved for surrogate values in UTF‐16. Note that all surrogate values are illegal as Unicode code points.
|===



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