Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

curl_easy_option_by_id (3)

Name

curl_easy_option_by_id - find an easy setopt option by id

Synopsis

#include <curl/curl.h>

const struct curl_easyoption *curl_easy_option_by_id(CURLoption id);

Description

curl_easy_option_by_id(3)       libcurl Manual       curl_easy_option_by_id(3)



NAME
       curl_easy_option_by_id - find an easy setopt option by id

SYNOPSIS
       #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  will return the non-aliases version for the cases where there
       is an alias function as well.

       If libcurl has no option with the given id, this function returns NULL.

EXAMPLE
       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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       curl_easy_option_by_name(3),curl_easy_option_next(3),
       curl_easy_setopt(3),



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source       was       downloaded      from       https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 04, 2021     curl_easy_option_by_id(3)