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

Return the UTF&hyphen;8 byte count needed for the given UTF&hyphen;16 input&period;

== Synopsis

Declared in `&lt;bdlde&lowbar;charconvertutf16&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
std::size&lowbar;t
computeRequiredUtf8Bytes(
    unsigned short const* srcBuffer,
    unsigned short const* endPtr = 0,
    xref:BloombergLP/bdlde/ByteOrder/Enum.adoc[ByteOrder::Enum] byteOrder = ByteOrder&colon;&colon;e&lowbar;HOST);
----

== Description

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

== Return Value

the number of UTF&hyphen;8 bytes required, including the terminating 0

== Parameters

[cols="1,4"]
|===
| Name| Description
| *srcBuffer*
| source buffer to measure
| *endPtr*
| one past the last input character, or 0 if null&hyphen;terminated
| *byteOrder*
| UTF&hyphen;16 byte order&semi; host order if unspecified
|===


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