1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
3<html><head>
4<title>CURLOPT_CONV_FROM_NETWORK_FUNCTION man page</title>
5<meta name="generator" content="roffit">
6<STYLE type="text/css">
7P.level0 {
8 padding-left: 2em;
9}
10
11P.level1 {
12 padding-left: 4em;
13}
14
15P.level2 {
16 padding-left: 6em;
17}
18
19span.emphasis {
20 font-style: italic;
21}
22
23span.bold {
24 font-weight: bold;
25}
26
27span.manpage {
28 font-weight: bold;
29}
30
31h2.nroffsh {
32 background-color: #e0e0e0;
33}
34
35span.nroffip {
36 font-weight: bold;
37 font-size: 120%;
38 font-family: monospace;
39}
40
41p.roffit {
42 text-align: center;
43 font-size: 80%;
44}
45</STYLE>
46</head><body>
47
48<p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
49<p class="level0">CURLOPT_CONV_FROM_NETWORK_FUNCTION - convert data from network to host encoding <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
50<p class="level0"><pre>
51<p class="level0">#include &lt;curl/curl.h&gt;
52 <p class="level0">CURLcode conv_callback(char *ptr, size_t length);
53 <p class="level0">CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONV_FROM_NETWORK_FUNCTION,
54 &nbsp;                         conv_callback);
55 </pre>
56<a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
57<p class="level0">Pass a pointer to your callback function, which should match the prototype shown above. 
58<p class="level0">Applies to non-ASCII platforms. <span Class="emphasis">curl_version_info(3)</span> will return the CURL_VERSION_CONV feature bit set if this option is provided. 
59<p class="level0">The data to be converted is in a buffer pointed to by the <span Class="emphasis">ptr</span> parameter. The amount of data to convert is indicated by the <span Class="emphasis">length</span> parameter.  The converted data overlays the input data in the buffer pointed to by the ptr parameter. <span Class="emphasis">CURLE_OK</span> must be returned upon successful conversion.  A CURLcode return value defined by curl.h, such as <span Class="emphasis">CURLE_CONV_FAILED</span>, should be returned if an error was encountered. 
60<p class="level0"><span Class="bold">CURLOPT_CONV_FROM_NETWORK_FUNCTION</span> converts to host encoding from the network encoding.  It is used when commands or ASCII data are received over the network. 
61<p class="level0">If you set a callback pointer to NULL, or don't set it at all, the built-in libcurl iconv functions will be used.  If HAVE_ICONV was not defined when libcurl was built, and no callback has been established, conversion will return the CURLE_CONV_REQD error code. 
62<p class="level0">If HAVE_ICONV is defined, CURL_ICONV_CODESET_OF_HOST must also be defined. For example: 
63<p class="level0">&nbsp;#define CURL_ICONV_CODESET_OF_HOST "IBM-1047" 
64<p class="level0">The iconv code in libcurl will default the network and UTF8 codeset names as follows: 
65<p class="level0">&nbsp;#define CURL_ICONV_CODESET_OF_NETWORK "ISO8859-1" 
66<p class="level0">&nbsp;#define CURL_ICONV_CODESET_FOR_UTF8   "UTF-8" 
67<p class="level0">You will need to override these definitions if they are different on your system. <a name="DEFAULT"></a><h2 class="nroffsh">DEFAULT</h2>
68<p class="level0">NULL <a name="PROTOCOLS"></a><h2 class="nroffsh">PROTOCOLS</h2>
69<p class="level0">FTP, SMTP, IMAP, POP3 <a name="EXAMPLE"></a><h2 class="nroffsh">EXAMPLE</h2>
70<p class="level0">TODO <a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
71<p class="level0">Available only if <span Class="bold">CURL_DOES_CONVERSIONS</span> was defined when libcurl was built. <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
72<p class="level0">Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
73<p class="level0"><a Class="manpage" href="/CURLOPT_CONV_TO_NETWORK_FUNCTION.html">CURLOPT_CONV_TO_NETWORK_FUNCTION</a> <a Class="manpage" href="/CURLOPT_CONV_FROM_UTF8_FUNCTION.html">CURLOPT_CONV_FROM_UTF8_FUNCTION</a> <span Class="manpage"> </span> <p class="roffit">
74 This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
75</body></html>
76