mirror of https://github.com/curl/curl.git synced 2024-12-09 06:30:06 +08:00

Daniel Stenberg e3fe020089

docs/libcurl: generate PROTOCOLS from meta-data

Remove the PROTOCOLS section from the source files completely and
instead generate them based on the header data in the curldown files.

It also generates TLS backend information for options marked for TLS as
protocol.

Closes #13175

2024-03-23 18:13:03 +01:00

1.1 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

curl

curl_easy_option_by_name

libcurl

curl_easy_option_by_id (3)

curl_easy_option_next (3)

curl_easy_setopt (3)

All

NAME

curl_easy_option_by_name - find an easy setopt option by name

SYNOPSIS

#include <curl/curl.h>

const struct curl_easyoption *curl_easy_option_by_name(const char *name);

DESCRIPTION

Given a name, this function returns a pointer to the curl_easyoption struct, holding information about the curl_easy_setopt(3) option using that name. The name should be specified without the "CURLOPT_" prefix and the name comparison is made case insensitive.

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

EXAMPLE

int main(void)
{
  const struct curl_easyoption *opt = curl_easy_option_by_name("URL");
  if(opt) {
    printf("This option wants CURLoption %x\n", (int)opt->id);
  }
}

AVAILABILITY

This function was added in libcurl 7.73.0

RETURN VALUE

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

1.1 KiB Raw Blame History