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

`utf8ToUtf32` overloads

== Synopses

Declared in `<bdlde_charconvertutf32.h>`

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


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdlde/CharConvertUtf32/utf8ToUtf32-07.adoc[utf8ToUtf32](
    xref:bsl/vector-00d.adoc[bsl::vector<unsigned int>]* dstVector,
    std::string_view const& srcString,
    unsigned int errorWord = '?',
    xref:BloombergLP/bdlde/ByteOrder/Enum.adoc[ByteOrder::Enum] byteOrder = ByteOrder::e_HOST);
----

[.small]#xref:BloombergLP/bdlde/CharConvertUtf32/utf8ToUtf32-07.adoc[_» more..._]#

Convert the UTF‐8 `srcString` into UTF‐32 in `dstVector`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdlde/CharConvertUtf32/utf8ToUtf32-04.adoc[utf8ToUtf32](
    xref:bsl/vector-00d.adoc[bsl::vector<unsigned int>]* dstVector,
    char const* srcString,
    unsigned int errorWord = '?',
    xref:BloombergLP/bdlde/ByteOrder/Enum.adoc[ByteOrder::Enum] byteOrder = ByteOrder::e_HOST);
----

[.small]#xref:BloombergLP/bdlde/CharConvertUtf32/utf8ToUtf32-04.adoc[_» more..._]#

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


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdlde/CharConvertUtf32/utf8ToUtf32-06.adoc[utf8ToUtf32](
    std::pmr::vector<unsigned int>* dstVector,
    std::string_view const& srcString,
    unsigned int errorWord = '?',
    xref:BloombergLP/bdlde/ByteOrder/Enum.adoc[ByteOrder::Enum] byteOrder = ByteOrder::e_HOST);
----

[.small]#xref:BloombergLP/bdlde/CharConvertUtf32/utf8ToUtf32-06.adoc[_» more..._]#

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


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdlde/CharConvertUtf32/utf8ToUtf32-00.adoc[utf8ToUtf32](
    std::pmr::vector<unsigned int>* dstVector,
    char const* srcString,
    unsigned int errorWord = '?',
    xref:BloombergLP/bdlde/ByteOrder/Enum.adoc[ByteOrder::Enum] byteOrder = ByteOrder::e_HOST);
----

[.small]#xref:BloombergLP/bdlde/CharConvertUtf32/utf8ToUtf32-00.adoc[_» more..._]#

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


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

[.small]#xref:BloombergLP/bdlde/CharConvertUtf32/utf8ToUtf32-0ac.adoc[_» more..._]#

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


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdlde/CharConvertUtf32/utf8ToUtf32-0e.adoc[utf8ToUtf32](
    std::vector<unsigned int>* dstVector,
    char const* srcString,
    unsigned int errorWord = '?',
    xref:BloombergLP/bdlde/ByteOrder/Enum.adoc[ByteOrder::Enum] byteOrder = ByteOrder::e_HOST);
----

[.small]#xref:BloombergLP/bdlde/CharConvertUtf32/utf8ToUtf32-0e.adoc[_» more..._]#

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


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdlde/CharConvertUtf32/utf8ToUtf32-02.adoc[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);
----

[.small]#xref:BloombergLP/bdlde/CharConvertUtf32/utf8ToUtf32-02.adoc[_» more..._]#

Convert the UTF‐8 `srcString` into UTF‐32 in `dstBuffer`.


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

[.small]#xref:BloombergLP/bdlde/CharConvertUtf32/utf8ToUtf32-0c.adoc[_» more..._]#

== Return Value

* 0 on success and a non‐zero status otherwise
* 0 on success and `CharConvertStatus::k_INVALID_INPUT_BIT` otherwise
* 0 on success and a bit‐wise OR of `CharConvertStatus::Enum` masks otherwise

== Parameters

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


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