[#BloombergLP-bdlde-CharConvertUtf16-computeRequiredUtf8Bytes-08]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlde.adoc[bdlde]::xref:BloombergLP/bdlde/CharConvertUtf16.adoc[CharConvertUtf16]::computeRequiredUtf8Bytes
:relfileprefix: ../../../
:mrdocs:

`computeRequiredUtf8Bytes` overloads

== Synopses

Declared in `<bdlde_charconvertutf16.h>`

Return the number of bytes required to store the UTF‐8 translation of the specified UTF‐16 `srcBuffer`, including the terminating null.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
std::size_t
xref:BloombergLP/bdlde/CharConvertUtf16/computeRequiredUtf8Bytes-04.adoc[computeRequiredUtf8Bytes](
    char16_t const* srcBuffer,
    char16_t const* endPtr = 0,
    xref:BloombergLP/bdlde/ByteOrder/Enum.adoc[ByteOrder::Enum] byteOrder = ByteOrder::e_HOST);
----

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

Return the length needed in bytes, for a buffer to hold the null‐terminated UTF‐8 string translated from the specified UTF‐16 string `srcBuffer` (including the terminating '0' in the returned count). Optionally specify `endPtr`, referring to one past the last input character. If `endPtr` is not supplied, or is 0, treat `srcBuffer` as 0 terminated. Optionally specify `byteOrder` indicating the byte order of `srcBuffer`; if `byteOrder` is not supplied, the host byte order is used. Note that this function will return the size `utf16ToUtf8` will require, assuming the `errorByte` argument to `utf16ToUtf8` is non‐zero.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
std::size_t
xref:BloombergLP/bdlde/CharConvertUtf16/computeRequiredUtf8Bytes-05.adoc[computeRequiredUtf8Bytes](
    unsigned short const* srcBuffer,
    unsigned short const* endPtr = 0,
    xref:BloombergLP/bdlde/ByteOrder/Enum.adoc[ByteOrder::Enum] byteOrder = ByteOrder::e_HOST);
----

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

Return the number of bytes required to store the UTF‐8 translation of the specified UTF‐16 `srcBuffer`, including the terminating null.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
std::size_t
xref:BloombergLP/bdlde/CharConvertUtf16/computeRequiredUtf8Bytes-01.adoc[computeRequiredUtf8Bytes](
    wchar_t const* srcBuffer,
    wchar_t const* endPtr = 0,
    xref:BloombergLP/bdlde/ByteOrder/Enum.adoc[ByteOrder::Enum] byteOrder = ByteOrder::e_HOST);
----

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


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