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

This `struct` provides a namespace for a suite of pure procedures to convert character buffers between UTF‐8 and UCS‐2. UCS‐2 conversions are performed to/from the full `2 ˆ 16` bit space (the "UTF‐16" hole U+D800‐U+DFFF is not treated as a special case). Note that all C‐style routines in this component honor _strlcpy_ semantics, meaning that all returned C‐style strings will be null‐terminated as long as the return buffer size is positive (i.e., `dstCapacity > 0`). Note that since all UCS‐2 operations take place as `unsigned short`s, byte order is not taken into consideration, and Byte Order Mark (BOM) characters are not generated. If a BOM is present in the input, it will be translated into the output.

== Synopsis

Declared in `<bdlde_charconvertucs2.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct CharConvertUcs2;
----

== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/CharConvertUcs2/ucs2ToUtf8-00.adoc[`ucs2ToUtf8`] 
| `ucs2ToUtf8` overloads
| xref:BloombergLP/bdlde/CharConvertUcs2/utf8ToUcs2-0dd.adoc[`utf8ToUcs2`] 
| `utf8ToUcs2` overloads
|===



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