Terminate encoding and write any retained output.

Synopsis

Declared in <bdlde_hexencoder.h>

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

Description

Write any retained output (e.g., from a previous call to convert with a non‐zero output limit argument) 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 a non‐negative value on success and a negative value otherwise. A successful return status indicates the number of characters that would be output if endConvert were called subsequently with no output limit. 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 reset; 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

a non‐negative value on success (characters that would be output if called again with no limit), and a negative value otherwise

Parameters

Name

Description

out

destination iterator for any retained output

Created with MrDocs