CURLOPT_SERVICE_NAME(3)

1CURLOPT_SERVICE_NAME(3)    curl_easy_setopt options    CURLOPT_SERVICE_NAME(3)
2
3
4

NAME

6       CURLOPT_SERVICE_NAME - authentication service name
7

SYNOPSIS

9       #include <curl/curl.h>
10
11       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SERVICE_NAME, char *name);
12

DESCRIPTION

14       Pass  a char * as parameter to a string holding the name of the service
15       for DIGEST-MD5, SPNEGO and Kerberos 5  authentication  mechanisms.  The
16       default  service  names  are  "ftp",  "HTTP", "imap", "ldap", "pop" and
17       "smtp". This option allows you to change them.
18
19       The application does not have to keep the string around  after  setting
20       this option.
21

DEFAULT

23       See above
24

PROTOCOLS

26       HTTP, FTP, IMAP, LDAP, POP3 and SMTP
27

EXAMPLE

29       CURL *curl = curl_easy_init();
30       if(curl) {
31         CURLcode ret;
32         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
33         curl_easy_setopt(curl, CURLOPT_SERVICE_NAME, "custom");
34         ret = curl_easy_perform(curl);
35       }
36

AVAILABILITY

38       Added  in  7.43.0 for HTTP, 7.49.0 for FTP, IMAP, POP3 and SMTP, 7.82.0
39       for OpenLDAP.
40

RETURN VALUE

42       Returns CURLE_OK if the option is  supported,  CURLE_UNKNOWN_OPTION  if
43       not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.
44