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

`convert` overloads

== Synopses

Declared in `<bdlde_base64decoder.h>`

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


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

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

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


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

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

Decode Base64 input for `char *` / `const char *` iterators.


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

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

Decode Base64 input for `unsigned char *` iterators.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<>
int
xref:BloombergLP/bdlde/Base64Decoder/convert-01.adoc[convert<unsigned char*, unsigned char const*>](
    unsigned char* out,
    int* numOut,
    int* numIn,
    unsigned char const* begin,
    unsigned char const* end,
    int maxNumOut = ‐1);
----

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

== Return Value

* non‐negative value on success, ‐1 on input error, and ‐2 if `endConvert` has already been called without an intervening `resetState`
* non‐negative value on success (positive count of retained output bytes if `maxNumOut` was reached), ‐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)
| *numOut*
| if non‐null, receives the number of bytes written
| *numIn*
| if non‐null, receives the number of input bytes consumed
| *maxNumOut*
| maximum bytes to write; negative means no limit
|===


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