diff options
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3')
| -rw-r--r-- | docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3 | 25 |
1 files changed, 12 insertions, 13 deletions
diff --git a/docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3 b/docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3 index 50a4adf35..768702006 100644 --- a/docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3 +++ b/docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 2021, Max Dymond, <max.dymond@microsoft.com>, et al. +.\" * Copyright (C) 2021 - 2022, Max Dymond, <max.dymond@microsoft.com>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -52,11 +52,15 @@ before a GET/HEAD/POST/etc request has been sent. This function may be called multiple times if redirections are enabled and are being followed (see \fICURLOPT_FOLLOWLOCATION(3)\fP). -This function is passed the following information: +The callback function must return \fICURL_PREREQFUNC_OK\fP on success, or +\fICURL_PREREQFUNC_ABORT\fP to cause the transfer to fail. + +This function is passed the following arguments: .IP conn_primary_ip A nul-terminated pointer to a C string containing the primary IP of the remote -server established with this connection. For FTP, this is the IP for the control -connection. IPv6 addresses are represented without surrounding brackets. +server established with this connection. For FTP, this is the IP for the +control connection. IPv6 addresses are represented without surrounding +brackets. .IP conn_local_ip A nul-terminated pointer to a C string containing the originating IP for this connection. IPv6 addresses are represented without surrounding brackets. @@ -65,15 +69,10 @@ The primary port number on the remote server established with this connection. For FTP, this is the port for the control connection. This can be a TCP or a UDP port number dependending on the protocol. .IP conn_local_port -The originating port number for this connection. This can be a TCP or a UDP port -number dependending on the protocol. -.RE - -\fIclientp\fP is the pointer you set with \fICURLOPT_PREREQDATA(3)\fP. - -The callback function must return \fICURL_PREREQFUNC_OK\fP on success, or -\fICURL_PREREQFUNC_ABORT\fP to cause the transfer to fail. - +The originating port number for this connection. This can be a TCP or a UDP +port number dependending on the protocol. +.IP clientp +The pointer you set with \fICURLOPT_PREREQDATA(3)\fP. .SH DEFAULT By default, this is NULL and unused. .SH PROTOCOLS |