curl / libcurl / API / curl_easy_option_by_id

curl_easy_option_by_id - lookup an easy option by id

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

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.