BloombergLP::bdlde::CharConvertUtf32::utf8ToUtf32

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

Synopsis

Declared in <bdlde_charconvertutf32.h>

static
int
utf8ToUtf32(
    unsigned int* dstBuffer,
    std::size_t dstCapacity,
    std::string_view const& srcString,
    std::size_t* numCodePointsWritten = 0,
    unsigned int errorWord = '?',
    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

NameDescription
dstBufferbuffer for the UTF-32 conversion result
dstCapacitycapacity of dstBuffer in words
srcStringUTF-8 source string view to convert
numCodePointsWrittenif non-null, receives the number of code points written (including the terminator)
errorWordoptional substitute for invalid encodings; 0 ignores them
byteOrderbyte order of the UTF-32 output (host by default)