mirror of
https://github.com/curl/curl.git
synced 2024-12-15 06:40:09 +08:00
230bb3e278
Make all libcurl related options use .nf (no fill) for the SYNOPSIS section - for consistent look. roffit then renders that section using <pre> (monospace font) in html for the website. Extended manpage-syntax (test 1173) with a basic check for it. Closes #8062
64 lines
2.2 KiB
Groff
64 lines
2.2 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 2021, 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
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_PREREQDATA 3 "2 Aug 2021" "libcurl 7.80.0" "curl_easy_setopt options"
|
|
.SH NAME
|
|
CURLOPT_PREREQDATA \- pointer passed to the pre-request callback
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PREREQDATA, void *pointer);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a \fIpointer\fP that will be untouched by libcurl and passed as the first
|
|
argument in the pre-request callback set with
|
|
\fICURLOPT_PREREQFUNCTION(3)\fP.
|
|
.SH DEFAULT
|
|
NULL
|
|
.SH PROTOCOLS
|
|
All
|
|
.SH EXAMPLE
|
|
.nf
|
|
static int prereq_callback(void *clientp,
|
|
char *conn_primary_ip,
|
|
char *conn_local_ip,
|
|
int conn_primary_port,
|
|
int conn_local_port)
|
|
{
|
|
printf("Connection made to %s:%s\\n", conn_primary_ip, conn_primary_port);
|
|
return CURL_PREREQFUNC_OK;
|
|
}
|
|
|
|
{
|
|
struct data prereq_data;
|
|
curl_easy_setopt(CURL *handle, CURLOPT_PREREQFUNCTION, prereq_callback);
|
|
curl_easy_setopt(CURL *handle, CURLOPT_PREREQDATA, &prereq_data);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.80.0
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_PREREQFUNCTION "(3) "
|