rtxBase64.h File Reference

#include "rtxsrc/rtxContext.h"

Go to the source code of this file.

Functions
EXTERNRT long	rtxBase64EncodeData (OSCTXT *pctxt, const char *pSrcData, size_t srcDataSize, OSOCTET **ppDstData)
	Encode binary data into base64 string form to a dynamic buffer.
EXTERNRT long	rtxBase64EncodeURLParam (OSCTXT *pctxt, const char *pSrcData, size_t srcDataSize, OSOCTET **ppDstData)
	Encode binary data into base64 string form to a dynamic buffer.
EXTERNRT long	rtxBase64DecodeData (OSCTXT *pctxt, const char *pSrcData, size_t srcDataSize, OSOCTET **ppDstData)
	Decode base64 string to binary form into a dynamic buffer.
EXTERNRT long	rtxBase64DecodeDataToFSB (OSCTXT *pctxt, const char *pSrcData, size_t srcDataSize, OSOCTET *buf, size_t bufsiz)
	Decode base64 string to binary form into a fixed-size buffer.
EXTERNRT long	rtxBase64GetBinDataLen (const char *pSrcData, size_t srcDataSize)
	Calculate number of byte required to hold a decoded base64 string in binary form.

---

Detailed Description

Definition in file rtxBase64.h.

---

Function Documentation

EXTERNRT long rtxBase64DecodeData	(	OSCTXT *	pctxt,
		const char *	pSrcData,
		size_t	srcDataSize,
		OSOCTET **	ppDstData
	)

Decode base64 string to binary form into a dynamic buffer.

Parameters:

	pctxt	Pointer to context structure.
	pSrcData	Pointer to base64 string to decode.
	srcDataSize	Length of the base64 string.
	ppDstData	Pointer to pointer variable to hold address of dynamically allocated buffer to hold data.

Returns:

Completion status of operation:

• number of binary bytes written
• negative return value is error.

EXTERNRT long rtxBase64DecodeDataToFSB	(	OSCTXT *	pctxt,
		const char *	pSrcData,
		size_t	srcDataSize,
		OSOCTET *	buf,
		size_t	bufsiz
	)

Decode base64 string to binary form into a fixed-size buffer.

Parameters:

	pctxt	Pointer to context structure.
	pSrcData	Pointer to base64 string to decode.
	srcDataSize	Length of the base64 string.
	buf	Address of buffer to receive decoded binary data.
	bufsiz	Size of output buffer.

Returns:

Completion status of operation:

• number of binary bytes written
• negative return value is error.

EXTERNRT long rtxBase64EncodeData	(	OSCTXT *	pctxt,
		const char *	pSrcData,
		size_t	srcDataSize,
		OSOCTET **	ppDstData
	)

Encode binary data into base64 string form to a dynamic buffer.

Parameters:

	pctxt	Pointer to context structure.
	pSrcData	Pointer to binary data to encode.
	srcDataSize	Length of the binary data in octets.
	ppDstData	Pointer to pointer variable to hold address of dynamically allocated buffer the encoded base64 string.

Returns:

Completion status of operation:

• number of binary bytes written
• negative return value is error.

EXTERNRT long rtxBase64EncodeURLParam	(	OSCTXT *	pctxt,
		const char *	pSrcData,
		size_t	srcDataSize,
		OSOCTET **	ppDstData
	)

Encode binary data into base64 string form to a dynamic buffer.

In this case, the encoded string may be used in a query string parameter in a URL.

Parameters:

	pctxt	Pointer to context structure.
	pSrcData	Pointer to binary data to encode.
	srcDataSize	Length of the binary data in octets.
	ppDstData	Pointer to pointer variable to hold address of dynamically allocated buffer the encoded base64 string.

Returns:

Completion status of operation:

• number of binary bytes written
• negative return value is error.

EXTERNRT long rtxBase64GetBinDataLen	(	const char *	pSrcData,
		size_t	srcDataSize
	)

Calculate number of byte required to hold a decoded base64 string in binary form.

Parameters:

	pSrcData	Pointer to base64 string to decode.
	srcDataSize	Length of the base64 string.

Returns:

Completion status of operation: If success, positive value is number of bytes, If failure, negative status code.