Cpl::Text::Encoding Namespace Reference

The 'Encoding' namespace provides various encoding algorithms for converting binary data to (and from) ASCII text to facilitate transport of the binary data using text based protocols. More...

Detailed Description

The 'Encoding' namespace provides various encoding algorithms for converting binary data to (and from) ASCII text to facilitate transport of the binary data using text based protocols.

Functions
bool	base64Encode (const void *binarySrc, size_t binarySrcLen, char *dstEncodedText, size_t dstSize, size_t &encodedOutputStringLen, bool insertMIMELineFeeds=false)
	This method encodes the specified binary data as Base64 (standard, with padding).
bool	base64Decode (const char *encodedTextSrc, size_t encodedTextSrcLen, void *dstBinary, size_t dstSize, size_t &dstBinaryLen)
	This method decodes a Base64 string to its binary representation.

Function Documentation

base64Decode()

bool Cpl::Text::Encoding::base64Decode	(	const char *	encodedTextSrc,
		size_t	encodedTextSrcLen,
		void *	dstBinary,
		size_t	dstSize,
		size_t &	dstBinaryLen
	)

This method decodes a Base64 string to its binary representation.

The caller is required to provide the memory to hold the encoded output.

The method returns true if the decoding succeeded; else false is returned (e.g. insufficient output memory)

base64Encode()

bool Cpl::Text::Encoding::base64Encode	(	const void *	binarySrc,
		size_t	binarySrcLen,
		char *	dstEncodedText,
		size_t	dstSize,
		size_t &	encodedOutputStringLen,
		bool	insertMIMELineFeeds = false
	)

This method encodes the specified binary data as Base64 (standard, with padding).

See https://datatracker.ietf.org/doc/html/rfc4648#section-4

The caller is required to provide the memory to hold the encoded output.

'dstSize' is ASSUMED to include space for the null terminator.

When 'insertMIMELineFeeds' is true, the output has non-encoded line feeds added to the output string to restrict the output line length to 76 characters.

The method returns true if the encoding succeeded; else false is returned (e.g. insufficient output memory)