mirror of
https://github.com/moparisthebest/curl
synced 2024-11-05 00:55:04 -05:00
82 lines
3.2 KiB
Groff
82 lines
3.2 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at http://curl.haxx.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_CONV_FROM_UTF8_FUNCTION 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
|
|
.SH NAME
|
|
CURLOPT_CONV_FROM_UTF8_FUNCTION \- convert data from UTF8 to host encoding
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode conv_callback(char *ptr, size_t length);
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONV_FROM_UTF8_FUNCTION,
|
|
conv_callback);
|
|
.SH DESCRIPTION
|
|
Pass a pointer to your callback function, which should match the prototype
|
|
shown above.
|
|
|
|
Applies to non-ASCII platforms. \fIcurl_version_info(3)\fP will return the
|
|
CURL_VERSION_CONV feature bit set if this option is provided.
|
|
|
|
The data to be converted is in a buffer pointed to by the \fIptr\fP parameter.
|
|
The amount of data to convert is indicated by the \fIlength\fP parameter. The
|
|
converted data overlays the input data in the buffer pointed to by the ptr
|
|
parameter. \fICURLE_OK\fP must be returned upon successful conversion. A
|
|
CURLcode return value defined by curl.h, such as \fICURLE_CONV_FAILED\fP,
|
|
should be returned if an error was encountered.
|
|
|
|
\fBCURLOPT_CONV_FROM_UTF8_FUNCTION\fP converts to host encoding from UTF8
|
|
encoding. It is required only for SSL processing.
|
|
|
|
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.
|
|
|
|
If HAVE_ICONV is defined, CURL_ICONV_CODESET_OF_HOST must also be defined.
|
|
For example:
|
|
|
|
\&#define CURL_ICONV_CODESET_OF_HOST "IBM-1047"
|
|
|
|
The iconv code in libcurl will default the network and UTF8 codeset names as
|
|
follows:
|
|
|
|
\&#define CURL_ICONV_CODESET_OF_NETWORK "ISO8859-1"
|
|
|
|
\&#define CURL_ICONV_CODESET_FOR_UTF8 "UTF-8"
|
|
|
|
You will need to override these definitions if they are different on your
|
|
system.
|
|
.SH DEFAULT
|
|
NULL
|
|
.SH PROTOCOLS
|
|
TLS-based protocols.
|
|
.SH EXAMPLE
|
|
TODO
|
|
.SH AVAILABILITY
|
|
Available only if \fBCURL_DOES_CONVERSIONS\fP was defined when libcurl was built.
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_CONV_TO_NETWORK_FUNCTION "(3), " CURLOPT_CONV_FROM_NETWORK_FUNCTION "(3), "
|