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

`convert` overloads

== Synopses

Declared in `<bdlde_base64encoder.h>`

Encode input bytes from `[begin, end)]` into Base64 at `out`.


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

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

Encode input bytes from `[begin, end)]` into Base64 with limits.


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

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

== Return Value

* a non‐negative value on success, and a negative value otherwise
* a non‐negative value on success (positive means retained output bytes not yet written), and a negative value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *out*
| output iterator for encoded characters
| *begin*
| beginning of the input byte range
| *end*
| end of the input byte range (one past the last byte)
| *numOut*
| optionally receives the number of output bytes produced
| *numIn*
| optionally receives the number of input bytes consumed
| *maxNumOut*
| maximum output bytes to emit; negative means no limit
|===


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