BloombergLP::bdlde::Base64Encoder::endConvert

Finish encoding, writing retained output to out with limits.

Synopsis

Declared in <bdlde_base64encoder.h>

template<class OUTPUT_ITERATOR>
int
endConvert(
    OUTPUT_ITERATOR out,
    int* numOut,
    int maxNumOut = -1);

Description

Terminate encoding for this encoder; write any retained output (e.g., from a previous call to convert) to the specified out buffer. Optionally specify the maxNumOut limit on the number of bytes to output; if maxNumOut is negative, no limit is imposed. Load into the (optionally) specified numOut the number of output bytes produced. Return 0 if output was successfully completed and a non-zero 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 encoder in the error state, and return an error status.

Return Value

0 if output was successfully completed, and a non-zero value otherwise

Parameters

NameDescription
outoutput iterator for any retained encoded characters
numOutreceives the number of output bytes produced
maxNumOutmaximum output bytes to emit; negative means no limit