mirror of
https://github.com/curl/curl.git
synced 2024-12-09 06:30:06 +08:00
67 lines
1.3 KiB
Markdown
67 lines
1.3 KiB
Markdown
|
---
|
||
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
||
|
SPDX-License-Identifier: curl
|
||
|
Title: CURLOPT_SERVICE_NAME
|
||
|
Section: 3
|
||
|
Source: libcurl
|
||
|
See-also:
|
||
|
- CURLOPT_PROXY (3)
|
||
|
- CURLOPT_PROXYTYPE (3)
|
||
|
- CURLOPT_PROXY_SERVICE_NAME (3)
|
||
|
---
|
||
|
|
||
|
# NAME
|
||
|
|
||
|
CURLOPT_SERVICE_NAME - authentication service name
|
||
|
|
||
|
# SYNOPSIS
|
||
|
|
||
|
~~~c
|
||
|
#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.
|
||
|
|
||
|
# DEFAULT
|
||
|
|
||
|
See above
|
||
|
|
||
|
# PROTOCOLS
|
||
|
|
||
|
HTTP, FTP, IMAP, LDAP, POP3 and SMTP
|
||
|
|
||
|
# EXAMPLE
|
||
|
|
||
|
~~~c
|
||
|
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 7.43.0 for HTTP, 7.49.0 for FTP, IMAP, POP3 and SMTP,
|
||
|
7.82.0 for OpenLDAP.
|
||
|
|
||
|
# 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.
|