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

`convert` overloads

== Synopses

Declared in `<bdlde_hexencoder.h>`

Encode input characters to hexadecimal output.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class OUTPUT_ITERATOR,
    class INPUT_ITERATOR>
int
xref:BloombergLP/bdlde/HexEncoder/convert-00.adoc[convert](
    OUTPUT_ITERATOR out,
    INPUT_ITERATOR begin,
    INPUT_ITERATOR end);
----

[.small]#xref:BloombergLP/bdlde/HexEncoder/convert-00.adoc[_» more..._]#

Encode input characters to hexadecimal output with limits.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class OUTPUT_ITERATOR,
    class INPUT_ITERATOR>
int
xref:BloombergLP/bdlde/HexEncoder/convert-0e.adoc[convert](
    OUTPUT_ITERATOR out,
    int* numOut,
    int* numIn,
    INPUT_ITERATOR begin,
    INPUT_ITERATOR end,
    int maxNumOut = ‐1);
----

[.small]#xref:BloombergLP/bdlde/HexEncoder/convert-0e.adoc[_» more..._]#

== 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)
| *numOut*
| number of output bytes produced
| *numIn*
| number of input bytes consumed
| *maxNumOut*
| maximum output bytes to write; negative means no limit
|===


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