quickjs-tart

quickjs-based runtime for wallet-core logic
Log | Files | Refs | README | LICENSE

CURLOPT_CONV_FROM_UTF8_FUNCTION.md (2823B)

      1 ---
      2 c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
      3 SPDX-License-Identifier: curl
      4 Title: CURLOPT_CONV_FROM_UTF8_FUNCTION
      5 Section: 3
      6 Source: libcurl
      7 Protocol:
      8   - All
      9 See-also:
     10   - CURLOPT_CONV_FROM_NETWORK_FUNCTION (3)
     11   - CURLOPT_CONV_TO_NETWORK_FUNCTION (3)
     12 Added-in: 7.15.4
     13 ---
     14 
     15 # NAME
     16 
     17 CURLOPT_CONV_FROM_UTF8_FUNCTION - convert data from UTF8 to host encoding
     18 
     19 # SYNOPSIS
     20 
     21 ~~~c
     22 #include <curl/curl.h>
     23 
     24 CURLcode conv_callback(char *ptr, size_t length);
     25 
     26 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONV_FROM_UTF8_FUNCTION,
     27                           conv_callback);
     28 ~~~
     29 
     30 # DESCRIPTION
     31 
     32 Pass a pointer to your callback function, which should match the prototype
     33 shown above.
     34 
     35 Applies to non-ASCII platforms. curl_version_info(3) returns the
     36 CURL_VERSION_CONV feature bit set if this option is provided.
     37 
     38 The data to be converted is in a buffer pointed to by the *ptr* parameter.
     39 The amount of data to convert is indicated by the *length* parameter. The
     40 converted data overlays the input data in the buffer pointed to by the ptr
     41 parameter. *CURLE_OK* must be returned upon successful conversion. A
     42 CURLcode return value defined by curl.h, such as *CURLE_CONV_FAILED*,
     43 should be returned if an error was encountered.
     44 
     45 CURLOPT_CONV_FROM_UTF8_FUNCTION(3) converts to host encoding from UTF8
     46 encoding. It is required only for SSL processing.
     47 
     48 If you set a callback pointer to NULL, or do not set it at all, the built-in
     49 libcurl iconv functions are used. If HAVE_ICONV was not defined when libcurl
     50 was built, and no callback has been established, the conversion returns the
     51 CURLE_CONV_REQD error code.
     52 
     53 If HAVE_ICONV is defined, CURL_ICONV_CODESET_OF_HOST must also be defined.
     54 For example:
     55 ~~~c
     56  #define CURL_ICONV_CODESET_OF_HOST "IBM-1047"
     57 ~~~
     58 
     59 The iconv code in libcurl defaults the network and UTF8 codeset names as
     60 follows:
     61 ~~~c
     62 #define CURL_ICONV_CODESET_OF_NETWORK "ISO8859-1"
     63 
     64 #define CURL_ICONV_CODESET_FOR_UTF8   "UTF-8"
     65 ~~~
     66 
     67 You need to override these definitions if they are different on your system.
     68 
     69 # DEFAULT
     70 
     71 NULL
     72 
     73 # %PROTOCOLS%
     74 
     75 # EXAMPLE
     76 
     77 ~~~c
     78 static CURLcode my_conv_from_utf8_to_ebcdic(char *buffer, size_t length)
     79 {
     80   int rc = 0;
     81   /* in-place convert 'buffer' from UTF-8 to EBCDIC */
     82   if(rc == 0) {
     83     /* success */
     84     return CURLE_OK;
     85   }
     86   else {
     87     return CURLE_CONV_FAILED;
     88   }
     89 }
     90 
     91 int main(void)
     92 {
     93   CURL *curl = curl_easy_init();
     94   curl_easy_setopt(curl, CURLOPT_CONV_FROM_UTF8_FUNCTION,
     95                    my_conv_from_utf8_to_ebcdic);
     96 }
     97 ~~~
     98 
     99 # DEPRECATED
    100 
    101 Not available and deprecated since 7.82.0.
    102 
    103 Available only if **CURL_DOES_CONVERSIONS** was defined when libcurl was
    104 built.
    105 
    106 # %AVAILABILITY%
    107 
    108 # RETURN VALUE
    109 
    110 curl_easy_setopt(3) returns a CURLcode indicating success or error.
    111 
    112 CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
    113 libcurl-errors(3).