Converts a UTF-16 encoded string to UTF-8.
template <typename u16bit_iterator, typename
-octet_iterator> void utf16to8 (u16bit_iterator start,
+octet_iterator> octet_iterator utf16to8 (u16bit_iterator start,
u16bit_iterator end, octet_iterator result);
start: an iterator pointing to the beginning of the
UTF-16 encoded string to convert.
end: an iterator pointing to pass-the-end of the
UTF-16 encoded string to convert.
result: an output iterator to the place in the UTF-8
-string where to append the result of conversion.
Example of use:
unsigned short utf16string[] = {0x41, 0x0448, 0x65e5, 0xd834, 0xdd1e};
@@ -290,14 +291,15 @@ assert (utf8result.size() == 10);
utf8::utf8to16
Converts an UTF-8 encoded string to UTF-16
template <typename u16bit_iterator, typename
-octet_iterator> void utf8to16 (octet_iterator start,
+octet_iterator> u16bit_iterator utf8to16 (octet_iterator start,
octet_iterator end, u16bit_iterator result);
start: an iterator pointing to the beginning of the
UTF-8 encoded string to convert. < br /> end: an
iterator pointing to pass-the-end of the UTF-8 encoded string to
convert.
result: an output iterator to the place in the UTF-16
-string where to append the result of conversion.
+string where to append the result of conversion.
+Return value: An iterator pointing to the place after the appended UTF-16 string.
Example of use:
unsigned char utf8_with_surrogates[] = {0xE6, 0x97, 0xA5, 0xd1, 0x88,
@@ -318,14 +320,15 @@ thrown.
utf8::utf32to8
Converts a UTF-32 encoded string to UTF-8.
template <typename octet_iterator, typename
-u32bit_iterator> void utf32to8 (u32bit_iterator start,
+u32bit_iterator> octet_iterator utf32to8 (u32bit_iterator start,
u32bit_iterator end, octet_iterator result);
start: an iterator pointing to the beginning of the
UTF-32 encoded string to convert.
end: an iterator pointing to pass-the-end of the
UTF-32 encoded string to convert.
result: an output iterator to the place in the UTF-8
-string where to append the result of conversion.
+string where to append the result of conversion.
+Return value: An iterator pointing to the place after the appended UTF-8 string.
Example of use:
int utf32string[] = {0x448, 0x65E5, 0x10346, 0};
@@ -340,14 +343,15 @@ assert (utf8result.size() == 9);
utf8::utf8to32
Converts a UTF-8 encoded string to UTF-32.
template <typename octet_iterator, typename
-u32bit_iterator> void utf8to32 (octet_iterator start,
+u32bit_iterator> u32bit_iterator utf8to32 (octet_iterator start,
octet_iterator end, u32bit_iterator result);
start: an iterator pointing to the beginning of the
UTF-8 encoded string to convert.
end: an iterator pointing to pass-the-end of the UTF-8
encoded string to convert.
result: an output iterator to the place in the UTF-32
-string where to append the result of conversion.
+string where to append the result of conversion.
+Return value: An iterator pointing to the place after the appended UTF-32 string.
Example of use:
unsigned char twochars[] = {0xE6, 0x97, 0xA5, 0xd1, 0x88, 0x0};
@@ -552,14 +556,15 @@ supplied UTF-8 sequence.
utf8::unchecked::utf16to8
Converts a UTF-16 encoded string to UTF-8.
template <typename u16bit_iterator, typename
-octet_iterator> void utf16to8 (u16bit_iterator start,
+octet_iterator> octet_iterator utf16to8 (u16bit_iterator start,
u16bit_iterator end, octet_iterator result);
start: an iterator pointing to the beginning of the
UTF-16 encoded string to convert.
end: an iterator pointing to pass-the-end of the
UTF-16 encoded string to convert.
result: an output iterator to the place in the UTF-8
-string where to append the result of conversion.
+string where to append the result of conversion.
+Return value: An iterator pointing to the place after the appended UTF-8 string.
Example of use:
unsigned short utf16string[] = {0x41, 0x0448, 0x65e5, 0xd834, 0xdd1e};
@@ -575,14 +580,17 @@ supplied UTF-16 sequence.
utf8::unchecked::utf8to16
Converts an UTF-8 encoded string to UTF-16
template <typename u16bit_iterator, typename
-octet_iterator> void utf8to16 (octet_iterator start,
+octet_iterator> u16bit_iterator utf8to16 (octet_iterator start,
octet_iterator end, u16bit_iterator result);
start: an iterator pointing to the beginning of the
UTF-8 encoded string to convert. < br /> end: an
iterator pointing to pass-the-end of the UTF-8 encoded string to
convert.
result: an output iterator to the place in the UTF-16
-string where to append the result of conversion.
+string where to append the result of conversion.
+Return value: An iterator pointing to the place after the appended UTF-16 string.
+
+
Example of use:
unsigned char utf8_with_surrogates[] = {0xE6, 0x97, 0xA5, 0xd1, 0x88,
@@ -601,14 +609,16 @@ supplied UTF-8 sequence.
utf8::unchecked::utf32to8
Converts a UTF-32 encoded string to UTF-8.
template <typename octet_iterator, typename
-u32bit_iterator> void utf32to8 (u32bit_iterator start,
+u32bit_iterator> octet_iterator utf32to8 (u32bit_iterator start,
u32bit_iterator end, octet_iterator result);
start: an iterator pointing to the beginning of the
UTF-32 encoded string to convert.
end: an iterator pointing to pass-the-end of the
UTF-32 encoded string to convert.
result: an output iterator to the place in the UTF-8
-string where to append the result of conversion.
+string where to append the result of conversion.
+Return value: An iterator pointing to the place after the appended UTF-8 string.
+
Example of use:
int utf32string[] = {0x448, 0x65E5, 0x10346, 0};
@@ -624,14 +634,16 @@ supplied UTF-32 sequence.
utf8::unchecked::utf8to32
Converts a UTF-8 encoded string to UTF-32.
template <typename octet_iterator, typename
-u32bit_iterator> void utf8to32 (octet_iterator start,
+u32bit_iterator> u32bit_iterator utf8to32 (octet_iterator start,
octet_iterator end, u32bit_iterator result);
start: an iterator pointing to the beginning of the
UTF-8 encoded string to convert.
end: an iterator pointing to pass-the-end of the UTF-8
encoded string to convert.
result: an output iterator to the place in the UTF-32
-string where to append the result of conversion.
+string where to append the result of conversion.
+Return value: An iterator pointing to the place after the appended UTF-32 string.
+
Example of use:
unsigned char twochars[] = {0xE6, 0x97, 0xA5, 0xd1, 0x88, 0x0};