JCL Help:MimeEncode@@SizeInt@

From Project JEDI Wiki
Jump to navigationJump to search


Summary

The primary Mime encoding routine.


Pascal

 procedure MimeEncode(const InputBuffer: TDynByteArray; InputOffset: SizeInt; const InputByteCount: SizeInt; out OutputBuffer: TDynByteArray; OutputOffset: SizeInt = 0); overload;
procedure MimeEncode(const InputBuffer: TDynByteArray; const InputByteCount: SizeInt; out OutputBuffer: TDynByteArray); overload;
procedure MimeEncode(const InputBuffer; const InputByteCount: SizeInt; out OutputBuffer); overload;


Parameters

Parameters Description
const InputBuffer: TDynByteArray Points to the memory block to encode.
const InputByteCount: SizeInt Number of bytes to encode.
out OutputBuffer: TDynByteArray Points to the output buffer.


Description

MimeEncode is the primary MIME-encoding routine and is used by MimeEncodeString and MimeEncodeStream but can also be used directly. CAUTION: OutputBuffer must have enough memory allocated to take all encoded output. MimeEncodedSize(InputBytesCount) calculates this amount in bytes. MimeEncode will then fill the entire OutputBuffer, so there is no OutputBytesCount result for this procedure. Preallocating all memory at once (as required by MimeEncode) avoids the time-consuming process of reallocation.


See Also

MimeEncodedSize MimeDecode


About

Unit

JclMime


Donator

Ralf Junker


Notes

If not all data fits into memory at once, you can use MimeEncode multiple times, but you must be very careful about the size of the InputBuffer. It should be set to a number that is a multiple of 3.


Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page