55 lines
1.2 KiB
Markdown
55 lines
1.2 KiB
Markdown
|
---
|
||
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
||
|
SPDX-License-Identifier: curl
|
||
|
Title: curl_easy_option_by_id
|
||
|
Section: 3
|
||
|
Source: libcurl
|
||
|
See-also:
|
||
|
- curl_easy_option_by_name (3)
|
||
|
- curl_easy_option_next (3)
|
||
|
- curl_easy_setopt (3)
|
||
|
---
|
||
|
|
||
|
# NAME
|
||
|
|
||
|
curl_easy_option_by_id - find an easy setopt option by id
|
||
|
|
||
|
# SYNOPSIS
|
||
|
|
||
|
~~~c
|
||
|
#include <curl/curl.h>
|
||
|
|
||
|
const struct curl_easyoption *curl_easy_option_by_id(CURLoption id);
|
||
|
~~~
|
||
|
|
||
|
# DESCRIPTION
|
||
|
|
||
|
Given a *CURLoption* **id**, this function returns a pointer to the
|
||
|
*curl_easyoption* struct, holding information about the
|
||
|
curl_easy_setopt(3) 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.
|
||
|
|
||
|
# EXAMPLE
|
||
|
|
||
|
~~~c
|
||
|
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);
|
||
|
}
|
||
|
}
|
||
|
~~~
|
||
|
|
||
|
# AVAILABILITY
|
||
|
|
||
|
This function was added in libcurl 7.73.0
|
||
|
|
||
|
# RETURN VALUE
|
||
|
|
||
|
A pointer to the *curl_easyoption* struct for the option or NULL.
|