2
0
mirror of https://codeberg.org/kiss-community/repo synced 2024-09-12 07:40:13 +00:00
repo/core/curl/files/curl_easy_option_by_id.3

40 lines
1.2 KiB
Groff
Raw Normal View History

.\" generated by cd2nroff 0.1 from curl_easy_option_by_id.md
2024-03-30 18:28:04 +00:00
.TH curl_easy_option_by_id 3 libcurl
.SH NAME
curl_easy_option_by_id \- find an easy setopt option by id
.SH SYNOPSIS
.nf
#include <curl/curl.h>
const struct curl_easyoption *curl_easy_option_by_id(CURLoption id);
.fi
.SH DESCRIPTION
Given a \fICURLoption\fP \fBid\fP, this function returns a pointer to the
\fIcurl_easyoption\fP struct, holding information about the
\fIcurl_easy_setopt(3)\fP option using that id. The option id is the CURLOPT_
prefix ones provided in the standard curl/curl.h header file. This function
returns the non\-alias version of the cases where there is an alias function as
well.
If libcurl has no option with the given id, this function returns NULL.
2024-03-30 18:28:04 +00:00
.SH PROTOCOLS
All
.SH EXAMPLE
.nf
int main(void)
{
const struct curl_easyoption *opt = curl_easy_option_by_id(CURLOPT_URL);
if(opt) {
printf("This option wants type %x\\n", opt->type);
}
}
.fi
.SH AVAILABILITY
This function was added in libcurl 7.73.0
.SH RETURN VALUE
A pointer to the \fIcurl_easyoption\fP struct for the option or NULL.
.SH SEE ALSO
.BR curl_easy_option_by_name (3),
.BR curl_easy_option_next (3),
.BR curl_easy_setopt (3)