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