2
0
mirror of https://codeberg.org/kiss-community/repo synced 2025-01-05 01:10:07 -07:00
repo/core/curl/files/CURLOPT_PREQUOTE.3
2024-11-09 22:03:25 -06:00

62 lines
1.7 KiB
Groff

.\" generated by cd2nroff 0.1 from CURLOPT_PREQUOTE.md
.TH CURLOPT_PREQUOTE 3 "2024-11-09" libcurl
.SH NAME
CURLOPT_PREQUOTE \- commands to run before an FTP transfer
.SH SYNOPSIS
.nf
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PREQUOTE,
struct curl_slist *cmds);
.fi
.SH DESCRIPTION
Pass a pointer to a linked list of FTP commands to pass to the server after
the transfer type is set. The linked list should be a fully valid list of
struct curl_slist structs properly filled in as described for
\fICURLOPT_QUOTE(3)\fP.
Using this option multiple times makes the last set string override the
previous ones. Set it to NULL to disable its use again.
libcurl does not copy the list, it needs to be kept around until after the
transfer has completed.
These commands are not performed when a directory listing is performed, only
for file transfers.
While \fICURLOPT_QUOTE(3)\fP and \fICURLOPT_POSTQUOTE(3)\fP work for SFTP,
this option does not.
.SH DEFAULT
NULL
.SH PROTOCOLS
This functionality affects ftp only
.SH EXAMPLE
.nf
int main(void)
{
struct curl_slist *cmdlist = NULL;
cmdlist = curl_slist_append(cmdlist, "SYST");
CURL *curl = curl_easy_init();
if(curl) {
CURLcode res;
curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/foo.bin");
/* pass in the FTP commands to run */
curl_easy_setopt(curl, CURLOPT_PREQUOTE, cmdlist);
res = curl_easy_perform(curl);
curl_easy_cleanup(curl);
}
curl_slist_free_all(cmdlist);
}
.fi
.SH AVAILABILITY
Added in curl 7.9.5
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO
.BR CURLOPT_POSTQUOTE (3),
.BR CURLOPT_QUOTE (3)