1
.\" **************************************************************************
3
.\" * Project ___| | | | _ \| |
4
.\" * / __| | | | |_) | |
5
.\" * | (__| |_| | _ <| |___
6
.\" * \___|\___/|_| \_\_____|
8
.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
10
.\" * This software is licensed as described in the file COPYING, which
11
.\" * you should have received as part of this distribution. The terms
12
.\" * are also available at http://curl.haxx.se/docs/copyright.html.
14
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15
.\" * copies of the Software, and permit persons to whom the Software is
16
.\" * furnished to do so, under the terms of the COPYING file.
18
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19
.\" * KIND, either express or implied.
21
.\" **************************************************************************
23
.TH CURLOPT_CONV_FROM_UTF8_FUNCTION 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
25
CURLOPT_CONV_FROM_UTF8_FUNCTION \- convert data from UTF8 to host encoding
28
#include <curl/curl.h>
30
CURLcode conv_callback(char *ptr, size_t length);
32
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONV_FROM_UTF8_FUNCTION,
35
Pass a pointer to your callback function, which should match the prototype
38
Applies to non-ASCII platforms. \fIcurl_version_info(3)\fP will return the
39
CURL_VERSION_CONV feature bit set if this option is provided.
41
The data to be converted is in a buffer pointed to by the \fIptr\fP parameter.
42
The amount of data to convert is indicated by the \fIlength\fP parameter. The
43
converted data overlays the input data in the buffer pointed to by the ptr
44
parameter. \fICURLE_OK\fP must be returned upon successful conversion. A
45
CURLcode return value defined by curl.h, such as \fICURLE_CONV_FAILED\fP,
46
should be returned if an error was encountered.
48
\fBCURLOPT_CONV_FROM_UTF8_FUNCTION\fP converts to host encoding from UTF8
49
encoding. It is required only for SSL processing.
51
If you set a callback pointer to NULL, or don't set it at all, the built-in
52
libcurl iconv functions will be used. If HAVE_ICONV was not defined when
53
libcurl was built, and no callback has been established, conversion will
54
return the CURLE_CONV_REQD error code.
56
If HAVE_ICONV is defined, CURL_ICONV_CODESET_OF_HOST must also be defined.
59
\&#define CURL_ICONV_CODESET_OF_HOST "IBM-1047"
61
The iconv code in libcurl will default the network and UTF8 codeset names as
64
\&#define CURL_ICONV_CODESET_OF_NETWORK "ISO8859-1"
66
\&#define CURL_ICONV_CODESET_FOR_UTF8 "UTF-8"
68
You will need to override these definitions if they are different on your
77
Available only if \fBCURL_DOES_CONVERSIONS\fP was defined when libcurl was built.
79
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
81
.BR CURLOPT_CONV_TO_NETWORK_FUNCTION "(3), " CURLOPT_CONV_FROM_NETWORK_FUNCTION "(3), "
added
removed
docs/libcurl/opts/CURLOPT_CONV_FROM_UTF8_FUNCTION.3
