mirror of https://github.com/curl/curl.git synced 2024-12-21 06:50:10 +08:00

Daniel Stenberg 5a488251f7

- make DEFAULT sections less repetitive

- make historic mentions use HISTORY

- generate the protocols section on `# %PROTOCOLS%` instead of guessing
  where to put it

- generate the availability section on `# %AVAILABILITY%` instead of
  guessing where to put it

- make the protocols section more verbose

Closes #14227

2024-07-19 17:03:25 +02:00

1.2 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

Added-in

curl

curl_easy_option_by_id

libcurl

curl_easy_option_by_name (3)

curl_easy_option_next (3)

curl_easy_setopt (3)

All

7.73.0

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

%PROTOCOLS%

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%

RETURN VALUE

A pointer to the curl_easyoption struct for the option or NULL.

1.2 KiB Raw Blame History