Complete decoding and flush any retained output to out.

Synopsis

Declared in <bdlde_base64decoder.h>

template<class OUTPUT_ITERATOR>
int
endConvert(OUTPUT_ITERATOR out);

Description

Terminate decoding for this decoder; write any retained output (e.g., from a previous call to convert with a non‐zero optionally specified maxNumOut argument) to the specified out buffer; encode any unprocessed input characters that do not complete a 3‐byte sequence. Return 0 on success, the positive number of bytes still retained by this decoder if an output limit was reached, and a negative value otherwise. Any retained bytes are available on a subsequent call to endConvert. Once this method is called, no additional input may be supplied without an intervening call to resetState; once this method returns a zero status, a subsequent call will place this decoder in the error state, and return an error status.

Return Value

0 on success, a positive number of retained bytes if an output limit was reached, and a negative value otherwise

Parameters

Name

Description

out

destination for any retained decoded bytes

Created with MrDocs