[#BloombergLP-bdlde-Base64Decoder-convert-08]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlde.adoc[bdlde]::xref:BloombergLP/bdlde/Base64Decoder.adoc[Base64Decoder]::convert
:relfileprefix: ../../../
:mrdocs:

Decode Base64 characters from `[begin, end)]` into `out`.

== Synopsis

Declared in `<bdlde_base64decoder.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

Decode the sequence of input characters starting at the specified `begin` position up to, but not including, the specified `end` position, writing any resulting output characters to the specified `out` buffer. Return a non‐negative value on success, ‐1 on an input error, and ‐2 if the `endConvert` method has already been called without an intervening `resetState` call. Note that it is recommended that after all calls to `convert` are finished, the `endConvert` method be called to complete the decoding of any unprocessed input characters that do not complete a 3‐byte sequence.

== Return Value

non‐negative value on success, ‐1 on input error, and ‐2 if `endConvert` has already been called without an intervening `resetState`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *out*
| destination for decoded output bytes
| *begin*
| beginning of the Base64 input range
| *end*
| end of the Base64 input range (exclusive)
|===


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