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