[#BloombergLP-bdlde-CharConvertUtf16-utf8ToUtf16-019]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlde.adoc[bdlde]::xref:BloombergLP/bdlde/CharConvertUtf16.adoc[CharConvertUtf16]::utf8ToUtf16
:relfileprefix: ../../../
:mrdocs:

Load into the destination the UTF‐16 conversion of the UTF‐8 source.

== Synopsis

Declared in `<bdlde_charconvertutf16.h>`

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

== Description

Return 0 on success and a non‐zero status otherwise. See the overload taking `bsl::wstring` for full contract details.

== Return Value

0 on success and a non‐zero status otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *dstVector*
| destination for the converted output
| *srcString*
| source string to convert
| *numCodePointsWritten*
| if non‐null, set to the code‐point count written
| *errorWord*
| replacement for invalid input, or 0 to skip
| *byteOrder*
| UTF‐16 byte order; host order if unspecified
|===


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