[#BloombergLP-bdlde-HexEncoder-convert-00]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlde.adoc[bdlde]::xref:BloombergLP/bdlde/HexEncoder.adoc[HexEncoder]::convert
:relfileprefix: ../../../
:mrdocs:

Encode input characters to hexadecimal output.

== Synopsis

Declared in `<bdlde_hexencoder.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class OUTPUT_ITERATOR,
    class INPUT_ITERATOR>
int
convert(
    OUTPUT_ITERATOR out,
    INPUT_ITERATOR begin,
    INPUT_ITERATOR end);
----

== Description

Append pending output (if any) addressed by the specified `out`, then consume and encode input from the specified `begin` up to but not including the specified `end`. Return a non‐negative value on success and a negative value otherwise. Note that after all calls to `convert` are finished, `endConvert` should be called to complete encoding of any unprocessed input.

== Return Value

a non‐negative value on success, and a negative value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *out*
| destination iterator for encoded output
| *begin*
| beginning of the input range to encode
| *end*
| end of the input range (one past the last element)
|===


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