| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 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 https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 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. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.\" |
| 23 |
.TH CURLOPT_CONV_FROM_UTF8_FUNCTION 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_CONV_FROM_UTF8_FUNCTION \- convert data from UTF8 to host encoding |
| 26 |
.SH SYNOPSIS |
| 27 |
.nf |
| 28 |
#include <curl/curl.h> |
| 29 |
|
| 30 |
CURLcode conv_callback(char *ptr, size_t length); |
| 31 |
|
| 32 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONV_FROM_UTF8_FUNCTION, |
| 33 |
conv_callback); |
| 34 |
.SH DESCRIPTION |
| 35 |
Pass a pointer to your callback function, which should match the prototype |
| 36 |
shown above. |
| 37 |
|
| 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. |
| 40 |
|
| 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. |
| 47 |
|
| 48 |
\fBCURLOPT_CONV_FROM_UTF8_FUNCTION\fP converts to host encoding from UTF8 |
| 49 |
encoding. It is required only for SSL processing. |
| 50 |
|
| 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. |
| 55 |
|
| 56 |
If HAVE_ICONV is defined, CURL_ICONV_CODESET_OF_HOST must also be defined. |
| 57 |
For example: |
| 58 |
|
| 59 |
\&#define CURL_ICONV_CODESET_OF_HOST "IBM-1047" |
| 60 |
|
| 61 |
The iconv code in libcurl will default the network and UTF8 codeset names as |
| 62 |
follows: |
| 63 |
|
| 64 |
\&#define CURL_ICONV_CODESET_OF_NETWORK "ISO8859-1" |
| 65 |
|
| 66 |
\&#define CURL_ICONV_CODESET_FOR_UTF8 "UTF-8" |
| 67 |
|
| 68 |
You will need to override these definitions if they are different on your |
| 69 |
system. |
| 70 |
.SH DEFAULT |
| 71 |
NULL |
| 72 |
.SH PROTOCOLS |
| 73 |
TLS-based protocols. |
| 74 |
.SH EXAMPLE |
| 75 |
.nf |
| 76 |
static CURLcode my_conv_from_utf8_to_ebcdic(char *buffer, size_t length) |
| 77 |
{ |
| 78 |
char *tempptrin, *tempptrout; |
| 79 |
size_t bytes = length; |
| 80 |
int rc; |
| 81 |
tempptrin = tempptrout = buffer; |
| 82 |
rc = platform_u2e(&tempptrin, &bytes, &tempptrout, &bytes); |
| 83 |
if(rc == PLATFORM_CONV_OK) { |
| 84 |
return CURLE_OK; |
| 85 |
} |
| 86 |
else { |
| 87 |
return CURLE_CONV_FAILED; |
| 88 |
} |
| 89 |
} |
| 90 |
|
| 91 |
curl_easy_setopt(curl, CURLOPT_CONV_FROM_UTF8_FUNCTION, |
| 92 |
my_conv_from_utf8_to_ebcdic); |
| 93 |
.fi |
| 94 |
.SH AVAILABILITY |
| 95 |
Available only if \fBCURL_DOES_CONVERSIONS\fP was defined when libcurl was built. |
| 96 |
.SH RETURN VALUE |
| 97 |
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
| 98 |
.SH "SEE ALSO" |
| 99 |
.BR CURLOPT_CONV_TO_NETWORK_FUNCTION "(3), " CURLOPT_CONV_FROM_NETWORK_FUNCTION "(3), " |