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

Encode input characters from `[begin, end)]` into Quoted‐Printable.

== Synopsis

Declared in `<bdlde_quotedprintableencoder.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
convert(
    char* out,
    int* numOut,
    int* numIn,
    char const* begin,
    char const* end,
    int maxNumOut = ‐1);
----

== Description

Append to the buffer addressed by the specified `out` all pending output (if there is any) up to the optionally specified `maxNumOut` limit (default is negative, meaning no limit) and, when there is no pending output and `maxNumOut` is still not reached, begin to consume and encode a sequence of input characters starting at the specified `begin` position, up to but not including the specified `end` position, writing any resulting output in the specified `out` buffer up to the (cumulative) `maxNumOut` limit. If `maxNumOut` limit is reached, no further input will be consumed. Load into the specified `numOut` and `numIn` the number of output bytes produced and input bytes consumed, respectively. 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. These bytes _may_ be available for output if this method is called with a sufficiently large `maxNumOut`. Note that calling this method after `endConvert` has been invoked without an intervening `reset` call will place this instance in an error state, and return an error status. Note also that it is recommended that after all calls to `convert` are finished, the `endConvert` method be called to complete the encoding of any unprocessed input characters.

== Return Value

a non‐negative value on success (the number of characters that would be output if `endConvert` were called with no limit), and a negative value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *out*
| buffer to receive encoded output characters
| *numOut*
| receives the number of output bytes produced
| *numIn*
| receives the number of input bytes consumed
| *begin*
| beginning of the input character range
| *end*
| end of the input character range (one past the last)
| *maxNumOut*
| maximum output bytes to emit; negative means no limit
|===


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