summaryrefslogtreecommitdiff
path: root/doc/sgml/gmime-iconv-utils.sgml
blob: a1d663798bcfb87a18a3da19f817f9a72eff23a6 (plain)
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
<refentry id="gmime-gmime-iconv-utils">
<refmeta>
<refentrytitle>gmime-iconv-utils</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GMIME Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>gmime-iconv-utils</refname><refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>
<synopsis>



char*       <link linkend="g-mime-iconv-strdup">g_mime_iconv_strdup</link>             (<link linkend="iconv-t">iconv_t</link> cd,
                                             const char *string);
char*       <link linkend="g-mime-iconv-strndup">g_mime_iconv_strndup</link>            (<link linkend="iconv-t">iconv_t</link> cd,
                                             const char *string,
                                             <link linkend="size-t">size_t</link> n);
char*       <link linkend="g-mime-iconv-utf8-to-locale">g_mime_iconv_utf8_to_locale</link>     (const char *string);
char*       <link linkend="g-mime-iconv-utf8-to-locale-length">g_mime_iconv_utf8_to_locale_length</link>
                                            (const char *string,
                                             <link linkend="size-t">size_t</link> n);
char*       <link linkend="g-mime-iconv-locale-to-utf8">g_mime_iconv_locale_to_utf8</link>     (const char *string);
char*       <link linkend="g-mime-iconv-locale-to-utf8-length">g_mime_iconv_locale_to_utf8_length</link>
                                            (const char *string,
                                             <link linkend="size-t">size_t</link> n);
</synopsis>
</refsynopsisdiv>





<refsect1>
<title>Description</title>
<para>

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="g-mime-iconv-strdup">g_mime_iconv_strdup ()</title>
<programlisting>char*       g_mime_iconv_strdup             (<link linkend="iconv-t">iconv_t</link> cd,
                                             const char *string);</programlisting>
<para>
Allocates a new string buffer containing <parameter>string</parameter> converted to
the destination charset described in <parameter>cd</parameter>.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>cd</parameter>&nbsp;:</entry>
<entry> conversion descriptor
</entry></row>
<row><entry align="right"><parameter>string</parameter>&nbsp;:</entry>
<entry> string in source charset
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>a new string buffer containing the original string
converted to the new charset.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-iconv-strndup">g_mime_iconv_strndup ()</title>
<programlisting>char*       g_mime_iconv_strndup            (<link linkend="iconv-t">iconv_t</link> cd,
                                             const char *string,
                                             <link linkend="size-t">size_t</link> n);</programlisting>
<para>
Allocates a new string buffer containing the first <parameter>n</parameter> bytes of
<parameter>string</parameter> converted to the destination charset as described by the
conversion descriptor <parameter>cd</parameter>.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>cd</parameter>&nbsp;:</entry>
<entry> conversion descriptor
</entry></row>
<row><entry align="right"><parameter>string</parameter>&nbsp;:</entry>
<entry> string in source charset
</entry></row>
<row><entry align="right"><parameter>n</parameter>&nbsp;:</entry>
<entry> number of bytes to convert
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>a new string buffer containing the first <parameter>n</parameter> bytes of
<parameter>string</parameter> converted to the destination charset as described by the
conversion descriptor <parameter>cd</parameter>.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-iconv-utf8-to-locale">g_mime_iconv_utf8_to_locale ()</title>
<programlisting>char*       g_mime_iconv_utf8_to_locale     (const char *string);</programlisting>
<para>
Allocates a new string buffer containing <parameter>string</parameter> converted to the
user's locale charset.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>string</parameter>&nbsp;:</entry>
<entry> string in UTF-8 charset
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>a new string buffer containing <parameter>string</parameter> converted to the
user's locale charset.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-iconv-utf8-to-locale-length">g_mime_iconv_utf8_to_locale_length ()</title>
<programlisting>char*       g_mime_iconv_utf8_to_locale_length
                                            (const char *string,
                                             <link linkend="size-t">size_t</link> n);</programlisting>
<para>
Allocates a new string buffer containing the first <parameter>n</parameter> bytes of
<parameter>string</parameter> converted to the user's locale charset.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>string</parameter>&nbsp;:</entry>
<entry> string in UTF-8 charset
</entry></row>
<row><entry align="right"><parameter>n</parameter>&nbsp;:</entry>
<entry> number of bytes to convert
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>a new string buffer containing the first <parameter>n</parameter> bytes of
<parameter>string</parameter> converted to the user's locale charset.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-iconv-locale-to-utf8">g_mime_iconv_locale_to_utf8 ()</title>
<programlisting>char*       g_mime_iconv_locale_to_utf8     (const char *string);</programlisting>
<para>
Allocates a new string buffer containing <parameter>string</parameter> in UTF-8.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>string</parameter>&nbsp;:</entry>
<entry> string in locale charset
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>a new string buffer containing <parameter>string</parameter> converted to UTF-8.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-iconv-locale-to-utf8-length">g_mime_iconv_locale_to_utf8_length ()</title>
<programlisting>char*       g_mime_iconv_locale_to_utf8_length
                                            (const char *string,
                                             <link linkend="size-t">size_t</link> n);</programlisting>
<para>
Allocates a new string buffer containing the first <parameter>n</parameter> bytes of
<parameter>string</parameter> converted to UTF-8.</para>
<para>

</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>string</parameter>&nbsp;:</entry>
<entry> string in locale charset
</entry></row>
<row><entry align="right"><parameter>n</parameter>&nbsp;:</entry>
<entry> number of bytes to convert
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>a new string buffer containing the first <parameter>n</parameter> bytes of
<parameter>string</parameter> converted to UTF-8.
</entry></row>
</tbody></tgroup></informaltable></refsect2>

</refsect1>




</refentry>