File: Poco.UTF16Encoding.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (132 lines) | stat: -rw-r--r-- 10,109 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Class Poco::UTF16Encoding</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.html" class="namespace">Poco</a></h1>
<h1 class="symbol">class UTF16Encoding</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Foundation<br />
<b>Package:</b> Text<br />
<b>Header:</b> Poco/UTF16Encoding.h</p>
<h2>Description</h2>
<div class="description">
<p>UTF-16 text encoding, as defined in <a href="http://www.ietf.org/rfc/rfc2781.txt" target="_blank">RFC 2781</a>. </p>
<p>When converting from UTF-16 to <a href="Poco.Unicode.html" title="class Poco::Unicode">Unicode</a>, surrogates are reported as they are - in other words, surrogate pairs are not combined into one <a href="Poco.Unicode.html" title="class Poco::Unicode">Unicode</a> character.  When converting from <a href="Poco.Unicode.html" title="class Poco::Unicode">Unicode</a> to UTF-16, however, characters outside the 16-bit range are converted into a low and high surrogate. </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b><a href="Poco.TextEncoding.html" title="class Poco::TextEncoding">TextEncoding</a></p>
<p><b>All Base Classes: </b><a href="Poco.TextEncoding.html" title="class Poco::TextEncoding">TextEncoding</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.UTF16Encoding.html#11571" title="Poco::UTF16Encoding::canonicalName()">canonicalName</a>, <a href="Poco.UTF16Encoding.html#11574" title="Poco::UTF16Encoding::characterMap()">characterMap</a>, <a href="Poco.UTF16Encoding.html#11575" title="Poco::UTF16Encoding::convert()">convert</a>, <a href="Poco.UTF16Encoding.html#11566" title="Poco::UTF16Encoding::getByteOrder()">getByteOrder</a>, <a href="Poco.UTF16Encoding.html#11572" title="Poco::UTF16Encoding::isA()">isA</a>, <a href="Poco.UTF16Encoding.html#11581" title="Poco::UTF16Encoding::queryConvert()">queryConvert</a>, <a href="Poco.UTF16Encoding.html#11584" title="Poco::UTF16Encoding::sequenceLength()">sequenceLength</a>, <a href="Poco.UTF16Encoding.html#11567" title="Poco::UTF16Encoding::setByteOrder()">setByteOrder</a></p>
<p><b>Inherited Functions: </b><a href="Poco.TextEncoding.html#10766" title="Poco::TextEncoding::add()">add</a>, <a href="Poco.TextEncoding.html#10762" title="Poco::TextEncoding::byName()">byName</a>, <a href="Poco.TextEncoding.html#10746" title="Poco::TextEncoding::canonicalName()">canonicalName</a>, <a href="Poco.TextEncoding.html#10749" title="Poco::TextEncoding::characterMap()">characterMap</a>, <a href="Poco.TextEncoding.html#10750" title="Poco::TextEncoding::convert()">convert</a>, <a href="Poco.TextEncoding.html#10764" title="Poco::TextEncoding::find()">find</a>, <a href="Poco.TextEncoding.html#10773" title="Poco::TextEncoding::global()">global</a>, <a href="Poco.TextEncoding.html#10747" title="Poco::TextEncoding::isA()">isA</a>, <a href="Poco.TextEncoding.html#10777" title="Poco::TextEncoding::manager()">manager</a>, <a href="Poco.TextEncoding.html#10752" title="Poco::TextEncoding::queryConvert()">queryConvert</a>, <a href="Poco.TextEncoding.html#10771" title="Poco::TextEncoding::remove()">remove</a>, <a href="Poco.TextEncoding.html#10755" title="Poco::TextEncoding::sequenceLength()">sequenceLength</a></p>
<h2>Enumerations</h2>
<h3><a name="11557">ByteOrderType</a></h3>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="11558">BIG_ENDIAN_BYTE_ORDER</a></p>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="11559">LITTLE_ENDIAN_BYTE_ORDER</a></p>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="11560">NATIVE_BYTE_ORDER</a></p>
<div class="description">
<p></p>
</div>
<h2>Constructors</h2>
<h3><a name="11561">UTF16Encoding</a></h3>
<p class="decl"><a href="Poco.UTF16Encoding.html" title="class Poco::UTF16Encoding">UTF16Encoding</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.UTF16Encoding.html#11557" title="enum  Poco::UTF16Encoding::ByteOrderType">ByteOrderType</a> byteOrder = NATIVE_BYTE_ORDER<br />);</p>
<div class="description">
<p>Creates and initializes the encoding for the given byte order. </p>
</div>
<h3><a name="11563">UTF16Encoding</a></h3>
<p class="decl"><a href="Poco.UTF16Encoding.html" title="class Poco::UTF16Encoding">UTF16Encoding</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;int byteOrderMark<br />);</p>
<div class="description">
<p>Creates and initializes the encoding for the byte-order indicated by the given byte-order mark, which is the <a href="Poco.Unicode.html" title="class Poco::Unicode">Unicode</a> character 0xFEFF. </p>
</div>
<h2>Destructor</h2>
<h3><a name="11565">~UTF16Encoding</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">~<a href="Poco.UTF16Encoding.html" title="class Poco::UTF16Encoding">UTF16Encoding</a>();</p>
<div class="description">
<p></p>
</div>
<h2>Member Functions</h2>
<h3><a name="11571">canonicalName</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const char * canonicalName() const;</p>
<div class="description">
<p></p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.TextEncoding.html#10746" title="Poco::TextEncoding::canonicalName()">Poco::TextEncoding::canonicalName()</a></p></div>
<h3><a name="11574">characterMap</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const CharacterMap &amp; characterMap() const;</p>
<div class="description">
<p></p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.TextEncoding.html#10749" title="Poco::TextEncoding::characterMap()">Poco::TextEncoding::characterMap()</a></p></div>
<h3><a name="11575">convert</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int convert(<br />&nbsp;&nbsp;&nbsp;&nbsp;const unsigned char * bytes<br />) const;</p>
<div class="description">
<p></p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.TextEncoding.html#10750" title="Poco::TextEncoding::convert()">Poco::TextEncoding::convert()</a></p></div>
<h3><a name="11577">convert</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int convert(<br />&nbsp;&nbsp;&nbsp;&nbsp;int ch,<br />&nbsp;&nbsp;&nbsp;&nbsp;unsigned char * bytes,<br />&nbsp;&nbsp;&nbsp;&nbsp;int length<br />) const;</p>
<div class="description">
<p></p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.TextEncoding.html#10758" title="Poco::TextEncoding::convert()">Poco::TextEncoding::convert()</a></p></div>
<h3><a name="11566">getByteOrder</a></h3>
<p class="decl"><a href="Poco.UTF16Encoding.html#11557" title="enum  Poco::UTF16Encoding::ByteOrderType">ByteOrderType</a> getByteOrder() const;</p>
<div class="description">
<p>Returns the byte-order currently in use. </p>
</div>
<h3><a name="11572">isA</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool isA(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; encodingName<br />) const;</p>
<div class="description">
<p></p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.TextEncoding.html#10747" title="Poco::TextEncoding::isA()">Poco::TextEncoding::isA()</a></p></div>
<h3><a name="11581">queryConvert</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int queryConvert(<br />&nbsp;&nbsp;&nbsp;&nbsp;const unsigned char * bytes,<br />&nbsp;&nbsp;&nbsp;&nbsp;int length<br />) const;</p>
<div class="description">
<p></p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.TextEncoding.html#10752" title="Poco::TextEncoding::queryConvert()">Poco::TextEncoding::queryConvert()</a></p></div>
<h3><a name="11584">sequenceLength</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int sequenceLength(<br />&nbsp;&nbsp;&nbsp;&nbsp;const unsigned char * bytes,<br />&nbsp;&nbsp;&nbsp;&nbsp;int length<br />) const;</p>
<div class="description">
<p></p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.TextEncoding.html#10755" title="Poco::TextEncoding::sequenceLength()">Poco::TextEncoding::sequenceLength()</a></p></div>
<h3><a name="11567">setByteOrder</a></h3>
<p class="decl">void setByteOrder(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.UTF16Encoding.html#11557" title="enum  Poco::UTF16Encoding::ByteOrderType">ByteOrderType</a> byteOrder<br />);</p>
<div class="description">
<p>Sets the byte order. </p>
</div>
<h3><a name="11569">setByteOrder</a></h3>
<p class="decl">void setByteOrder(<br />&nbsp;&nbsp;&nbsp;&nbsp;int byteOrderMark<br />);</p>
<div class="description">
<p>Sets the byte order according to the given byte order mark, which is the <a href="Poco.Unicode.html" title="class Poco::Unicode">Unicode</a> character 0xFEFF. </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>