[#BloombergLP-bdlde-CharConvertUcs2-utf8ToUcs2-0dd]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlde.adoc[bdlde]::xref:BloombergLP/bdlde/CharConvertUcs2.adoc[CharConvertUcs2]::utf8ToUcs2
:relfileprefix: ../../../
:mrdocs:

`utf8ToUcs2` overloads

== Synopses

Declared in `<bdlde_charconvertucs2.h>`

Load into `result` the UCS‐2 conversion of the null‐terminated UTF‐8 `srcString`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdlde/CharConvertUcs2/utf8ToUcs2-06.adoc[utf8ToUcs2](
    xref:bsl/vector-00d.adoc[bsl::vector<unsigned short>]* result,
    char const* srcString,
    unsigned short errorCharacter = '?');
----

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

Load into `result` the UCS‐2 conversion of the null‐terminated UTF‐8 `srcString`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdlde/CharConvertUcs2/utf8ToUcs2-04.adoc[utf8ToUcs2](
    std::pmr::vector<unsigned short>* result,
    char const* srcString,
    unsigned short errorCharacter = '?');
----

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

Load into `result` the UCS‐2 conversion of the null‐terminated UTF‐8 `srcString`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdlde/CharConvertUcs2/utf8ToUcs2-09.adoc[utf8ToUcs2](
    std::vector<unsigned short>* result,
    char const* srcString,
    unsigned short errorCharacter = '?');
----

[.small]#xref:BloombergLP/bdlde/CharConvertUcs2/utf8ToUcs2-09.adoc[_» more..._]#

Convert a null‐terminated UTF‐8 string to UCS‐2 in a fixed buffer.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdlde/CharConvertUcs2/utf8ToUcs2-0d2.adoc[utf8ToUcs2](
    unsigned short* dstBuffer,
    std::size_t dstCapacity,
    char const* srcString,
    std::size_t* numCharsWritten = 0,
    unsigned short errorCharacter = '?');
----

[.small]#xref:BloombergLP/bdlde/CharConvertUcs2/utf8ToUcs2-0d2.adoc[_» more..._]#

== Return Value

* 0 on success and `CharConvertStatus::k_INVALID_INPUT_BIT` otherwise
* 0 on success and a non‐zero status otherwise
* 0 on success and a bitwise‐or of the masks specified by `CharConvertStatus::Enum` otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *result*
| output vector for the UCS‐2 conversion
| *srcString*
| null‐terminated UTF‐8 input
| *errorCharacter*
| substitute for invalid input; 0 skips them
| *dstBuffer*
| output buffer for the UCS‐2 conversion
| *dstCapacity*
| capacity of `dstBuffer` in `unsigned short`s
| *numCharsWritten*
| if non‐null, receives character count written
|===


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