[#BloombergLP-bdlde-CharConvertUtf32-utf8ToUtf32-02]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlde.adoc[bdlde]::xref:BloombergLP/bdlde/CharConvertUtf32.adoc[CharConvertUtf32]::utf8ToUtf32
:relfileprefix: ../../../
:mrdocs:

Convert the UTF‐8 source into UTF‐32 in the destination buffer.

== Synopsis

Declared in `<bdlde_charconvertutf32.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
utf8ToUtf32(
    unsigned int* dstBuffer,
    std::size_t dstCapacity,
    std::string_view const& srcString,
    std::size_t* numCodePointsWritten = 0,
    unsigned int errorWord = '?',
    xref:BloombergLP/bdlde/ByteOrder/Enum.adoc[ByteOrder::Enum] byteOrder = ByteOrder::e_HOST);
----

== Description

Load into the destination the UTF‐32 conversion of the UTF‐8 source. Return 0 on success and a non‐zero status otherwise. See the first `utf8ToUtf32` overload in this group for full contract details.

== Return Value

0 on success and a non‐zero status otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *dstBuffer*
| buffer for the UTF‐32 conversion result
| *dstCapacity*
| capacity of `dstBuffer` in words
| *srcString*
| UTF‐8 source string view to convert
| *numCodePointsWritten*
| if non‐null, receives the number of code points written (including the terminator)
| *errorWord*
| optional substitute for invalid encodings; 0 ignores them
| *byteOrder*
| byte order of the UTF‐32 output (host by default)
|===


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