mirror of
https://github.com/curl/curl.git
synced 2026-05-24 13:16:25 +03:00
d01d2ec9f1
Some CURLOPT constants defined in the curl public headers were initially enums (= ints), or macros with bare numeric values. Recent curl releases upgraded them to `long` constants, to make them pass correctly to `curl_easy_setop()` by default, i.e. without requiring a `(long)` cast. This patch drops such casts from the examples embedded in the docs. At the same time it documents which curl release made them `long` types, to keep them useful when working with previous libcurl versions. Also: - drop a `(long)` cast that was never necessary. - CURLOPT_ALTSVC_CTRL.md: bump local copy of macros to long. - test1119: make it ignore symbols ending with an underscore, to skip wildcard, e.g. `**CURLAUTH_***`. Closes #18130
83 lines
1.7 KiB
Markdown
83 lines
1.7 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_FTPSSLAUTH
|
|
Section: 3
|
|
Source: libcurl
|
|
Protocol:
|
|
- FTP
|
|
See-also:
|
|
- CURLOPT_FTP_SSL_CCC (3)
|
|
- CURLOPT_USE_SSL (3)
|
|
Added-in: 7.12.2
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_FTPSSLAUTH - order in which to attempt TLS vs SSL
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTPSSLAUTH, long order);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass a long using one of the values from below, to alter how libcurl issues
|
|
"AUTH TLS" or "AUTH SSL" when FTP over SSL is activated. This is only
|
|
interesting if CURLOPT_USE_SSL(3) is also set.
|
|
|
|
Possible *order* values:
|
|
|
|
## CURLFTPAUTH_DEFAULT
|
|
|
|
Allow libcurl to decide.
|
|
|
|
## CURLFTPAUTH_SSL
|
|
|
|
Try "AUTH SSL" first, and only if that fails try "AUTH TLS".
|
|
|
|
## CURLFTPAUTH_TLS
|
|
|
|
Try "AUTH TLS" first, and only if that fails try "AUTH SSL".
|
|
|
|
# DEFAULT
|
|
|
|
CURLFTPAUTH_DEFAULT
|
|
|
|
# %PROTOCOLS%
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode res;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/file.txt");
|
|
curl_easy_setopt(curl, CURLOPT_USE_SSL, CURLUSESSL_TRY);
|
|
/* funny server, ask for SSL before TLS */
|
|
curl_easy_setopt(curl, CURLOPT_FTPSSLAUTH, CURLFTPAUTH_SSL);
|
|
res = curl_easy_perform(curl);
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# HISTORY
|
|
|
|
**CURLFTPAUTH_*** enums became `long` types in 8.16.0, prior to this version
|
|
a `long` cast was necessary when passed to curl_easy_setopt(3).
|
|
|
|
# %AVAILABILITY%
|
|
|
|
# RETURN VALUE
|
|
|
|
curl_easy_setopt(3) returns a CURLcode indicating success or error.
|
|
|
|
CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
|
|
libcurl-errors(3).
|