ACE_Encoding_Converter Class Reference

#include <Encoding_Converter.h>

Inheritance diagram for ACE_Encoding_Converter:

[legend]

List of all members.

Public Types
enum	Result { CONVERSION_OK, SOURCE_EXHAUSTED, TARGET_EXHAUSTED, SOURCE_ILLEGAL }
Public Member Functions
virtual	~ACE_Encoding_Converter (void)
virtual Result	to_utf8 (const void *source, size_t source_size, ACE_Byte *target, size_t target_size, bool strict=true)=0
virtual Result	from_utf8 (const ACE_Byte *source, size_t source_size, void *target, size_t target_size, bool strict=true)=0

---

Detailed Description

The base class for all ACE UTF Encoding Converters. This class provides a generic interface that is used to implement various UTF encoding conversion classes.

---

Member Enumeration Documentation

enum ACE_Encoding_Converter::Result

This enum describes the various states that can be returned from the to_utf8() and from_utf8() methods which depends on both the source buffer and the size of the target buffer.

Enumerator:

CONVERSION_OK
SOURCE_EXHAUSTED
TARGET_EXHAUSTED
SOURCE_ILLEGAL

---

Constructor & Destructor Documentation

virtual ACE_Encoding_Converter::~ACE_Encoding_Converter

(

void

)

[virtual]

This destructor is here (and virtual) because we have virtual functions.

---

Member Function Documentation

virtual Result ACE_Encoding_Converter::from_utf8	(	const ACE_Byte *	source,
		size_t	source_size,
		void *	target,
		size_t	target_size,
		bool	strict = true
	)			[pure virtual]

Convert the UTF-8 source into an alternate encoding and store it in the provided target buffer.

Implemented in ACE_UTF16_Encoding_Converter, ACE_UTF32_Encoding_Converter, and ACE_UTF8_Encoding_Converter.

virtual Result ACE_Encoding_Converter::to_utf8	(	const void *	source,
		size_t	source_size,
		ACE_Byte *	target,
		size_t	target_size,
		bool	strict = true
	)			[pure virtual]

Convert the source (which can be in any encoding) to UTF-8 and store it in the provided target buffer.

Implemented in ACE_UTF16_Encoding_Converter, ACE_UTF32_Encoding_Converter, and ACE_UTF8_Encoding_Converter.

---

The documentation for this class was generated from the following file:

• Encoding_Converter.h