Return to CURLOPT_CONV_FROM_NETWORK_FUNCTION.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_CONV_FROM_NETWORK_FUNCTION.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, 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_NETWORK_FUNCTION 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_CONV_FROM_NETWORK_FUNCTION \- convert data from network to host encoding
                     27: .SH SYNOPSIS
                     28: .nf
                     29: #include <curl/curl.h>
                     30: 
                     31: CURLcode conv_callback(char *ptr, size_t length);
                     32: 
                     33: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONV_FROM_NETWORK_FUNCTION,
                     34:                           conv_callback);
                     35: .SH DESCRIPTION
                     36: Pass a pointer to your callback function, which should match the prototype
                     37: shown above.
                     38: 
                     39: Applies to non-ASCII platforms. \fIcurl_version_info(3)\fP will return the
                     40: CURL_VERSION_CONV feature bit set if this option is provided.
                     41: 
                     42: The data to be converted is in a buffer pointed to by the \fIptr\fP parameter.
                     43: The amount of data to convert is indicated by the \fIlength\fP parameter.  The
                     44: converted data overlays the input data in the buffer pointed to by the ptr
                     45: parameter. \fICURLE_OK\fP must be returned upon successful conversion.  A
                     46: CURLcode return value defined by curl.h, such as \fICURLE_CONV_FAILED\fP,
                     47: should be returned if an error was encountered.
                     48: 
                     49: \fBCURLOPT_CONV_FROM_NETWORK_FUNCTION\fP converts to host encoding from the
                     50: network encoding.  It is used when commands or ASCII data are received over
                     51: the network.
                     52: 
                     53: If you set a callback pointer to NULL, or don't set it at all, the built-in
                     54: libcurl iconv functions will be used.  If HAVE_ICONV was not defined when
                     55: libcurl was built, and no callback has been established, conversion will
                     56: return the CURLE_CONV_REQD error code.
                     57: 
                     58: If HAVE_ICONV is defined, CURL_ICONV_CODESET_OF_HOST must also be defined.
                     59: For example:
                     60: 
                     61:  \&#define CURL_ICONV_CODESET_OF_HOST "IBM-1047"
                     62: 
                     63: The iconv code in libcurl will default the network and UTF8 codeset names as
                     64: follows:
                     65: 
                     66:  \&#define CURL_ICONV_CODESET_OF_NETWORK "ISO8859-1"
                     67: 
                     68:  \&#define CURL_ICONV_CODESET_FOR_UTF8   "UTF-8"
                     69: 
                     70: You will need to override these definitions if they are different on your
                     71: system.
                     72: .SH DEFAULT
                     73: NULL
                     74: .SH PROTOCOLS
                     75: FTP, SMTP, IMAP, POP3
                     76: .SH EXAMPLE
                     77: .nf
                     78: static CURLcode my_conv_from_ascii_to_ebcdic(char *buffer, size_t length)
                     79: {
                     80:   char *tempptrin, *tempptrout;
                     81:   size_t bytes = length;
                     82:   int rc;
                     83:   tempptrin = tempptrout = buffer;
                     84:   rc = platform_a2e(&tempptrin, &bytes, &tempptrout, &bytes);
                     85:   if(rc == PLATFORM_CONV_OK) {
                     86:     return CURLE_OK;
                     87:   }
                     88:   else {
                     89:     return CURLE_CONV_FAILED;
                     90:   }
                     91: }
                     92: 
                     93: /* use platform-specific functions for codeset conversions */
                     94: curl_easy_setopt(curl, CURLOPT_CONV_FROM_NETWORK_FUNCTION,
                     95:                  my_conv_from_ascii_to_ebcdic);
                     96: .fi
                     97: .SH AVAILABILITY
                     98: Available only if \fBCURL_DOES_CONVERSIONS\fP was defined when libcurl was built.
                     99: .SH RETURN VALUE
                    100: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
                    101: .SH "SEE ALSO"
                    102: .BR CURLOPT_CONV_TO_NETWORK_FUNCTION "(3), " CURLOPT_CONV_FROM_UTF8_FUNCTION "(3), "