curl / libcurl / API / curl_easy_setopt / CURLOPT_SERVICE_NAME

CURLOPT_SERVICE_NAME explained

Name

CURLOPT_SERVICE_NAME - authentication service name

Synopsis

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

Description

Pass a char pointer as parameter to a string holding the name of the service for DIGEST-MD5, SPNEGO and Kerberos 5 authentication mechanisms. The default service names are "ftp", "HTTP", "imap", "ldap", "pop" and "smtp". This option allows you to change them.

The application does not have to keep the string around after setting this option.

Using this option multiple times makes the last set string override the previous ones. Set it to NULL to disable its use again.

Default

See above

Protocols

This functionality affects ftp, http, imap, ldap, pop3 and smtp

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode ret;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
    curl_easy_setopt(curl, CURLOPT_SERVICE_NAME, "custom");
    ret = curl_easy_perform(curl);
  }
}

Availability

Added in curl 7.43.0

Return value

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