curl_easy_option_by_name.3 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
  9. .\" *
  10. .\" * This software is licensed as described in the file COPYING, which
  11. .\" * you should have received as part of this distribution. The terms
  12. .\" * are also available at https://curl.se/docs/copyright.html.
  13. .\" *
  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15. .\" * copies of the Software, and permit persons to whom the Software is
  16. .\" * furnished to do so, under the terms of the COPYING file.
  17. .\" *
  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19. .\" * KIND, either express or implied.
  20. .\" *
  21. .\" **************************************************************************
  22. .TH curl_easy_option_by_name 3 "27 Aug 2020" "libcurl 7.73.0" "libcurl Manual"
  23. .SH NAME
  24. curl_easy_option_by_name - find an easy setopt option by name
  25. .SH SYNOPSIS
  26. .nf
  27. #include <curl/curl.h>
  28. const struct curl_easyoption *curl_easy_option_by_name(const char *name);
  29. .fi
  30. .SH DESCRIPTION
  31. Given a \fBname\fP, this function returns a pointer to the curl_easyoption
  32. struct, holding information about the \fIcurl_easy_setopt(3)\fP option using
  33. that name. The name should be specified without the "CURLOPT_" prefix and the
  34. name comparison is made case insensitive.
  35. If libcurl has no option with the given name, this function returns NULL.
  36. .SH AVAILABILITY
  37. This function was added in libcurl 7.73.0
  38. .SH RETURN VALUE
  39. A pointer to the curl_easyoption struct for the option or NULL.
  40. .SH "SEE ALSO"
  41. .BR curl_easy_option_next "(3)," curl_easy_option_by_id "(3),"
  42. .BR curl_easy_setopt "(3),"