curl/docs/libcurl/curl_easy_option_by_name.md
Daniel Stenberg 5a488251f7
curldown: fixups
- 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.1 KiB

c SPDX-License-Identifier Title Section Source See-also Protocol Added-in
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. curl curl_easy_option_by_name 3 libcurl
curl_easy_option_by_id (3)
curl_easy_option_next (3)
curl_easy_setopt (3)
All
7.73.0

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.

%PROTOCOLS%

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%

RETURN VALUE

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