[#BloombergLP-bdlde-CharConvertUtf32-utf32ToUtf8-09]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlde.adoc[bdlde]::xref:BloombergLP/bdlde/CharConvertUtf32.adoc[CharConvertUtf32]::utf32ToUtf8
:relfileprefix: ../../../
:mrdocs:

`utf32ToUtf8` overloads

== Synopses

Declared in `<bdlde_charconvertutf32.h>`

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


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdlde/CharConvertUtf32/utf32ToUtf8-03d.adoc[utf32ToUtf8](
    xref:bsl/string.adoc[bsl::string]* dstString,
    unsigned int const* srcString,
    std::size_t* numCodePointsWritten = 0,
    unsigned char errorByte = '?',
    xref:BloombergLP/bdlde/ByteOrder/Enum.adoc[ByteOrder::Enum] byteOrder = ByteOrder::e_HOST);
----

[.small]#xref:BloombergLP/bdlde/CharConvertUtf32/utf32ToUtf8-03d.adoc[_» more..._]#

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

Convert the UTF‐32 source of given length into UTF‐8 in `dstString`.


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

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

Convert the UTF‐32 source of given length into UTF‐8 in `dstString`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdlde/CharConvertUtf32/utf32ToUtf8-02f.adoc[utf32ToUtf8](
    std::pmr::string* dstString,
    unsigned int const* srcString,
    std::size_t srcStringLength,
    std::size_t* numCodePointsWritten = 0,
    unsigned char errorByte = '?',
    xref:BloombergLP/bdlde/ByteOrder/Enum.adoc[ByteOrder::Enum] byteOrder = ByteOrder::e_HOST);
----

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

Convert the UTF‐32 source of given length into UTF‐8 in `dstString`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdlde/CharConvertUtf32/utf32ToUtf8-066.adoc[utf32ToUtf8](
    std::string* dstString,
    unsigned int const* srcString,
    std::size_t srcStringLength,
    std::size_t* numCodePointsWritten = 0,
    unsigned char errorByte = '?',
    xref:BloombergLP/bdlde/ByteOrder/Enum.adoc[ByteOrder::Enum] byteOrder = ByteOrder::e_HOST);
----

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

Convert the UTF‐32 source of given length into UTF‐8 in `dstVector`.


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

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

Convert the UTF‐32 source of given length into UTF‐8 in `dstVector`.


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

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

Convert the UTF‐32 source of given length into UTF‐8 in `dstVector`.


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

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

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


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

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

Convert the UTF‐32 source of given length into UTF‐8 in `dstBuffer`.


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

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

== Return Value

* 0 on success or `CharConvertStatus::k_INVALID_INPUT_BIT` on invalid input
* 0 on success and a non‐zero status otherwise
* 0 on success or a bit‐wise OR of `CharConvertStatus` flags otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *dstString*
| destination for the UTF‐8 conversion result
| *srcString*
| null‐terminated UTF‐32 source string to convert
| *numCodePointsWritten*
| if non‐null, receives the number of UTF‐8 code points written (including terminator)
| *errorByte*
| optional substitute for invalid UTF‐32 values; 0 writes nothing
| *byteOrder*
| byte order of the UTF‐32 input (host by default)
| *dstVector*
| destination for the null‐terminated UTF‐8 result
| *srcStringLength*
| number of UTF‐32 values to convert
| *dstBuffer*
| buffer for the UTF‐8 conversion result
| *dstCapacity*
| capacity of `dstBuffer` in bytes
| *numBytesWritten*
| if non‐null, receives the number of bytes written
|===


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