CURLOPT_FNMATCH_FUNCTION.3 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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. .\"
  23. .TH CURLOPT_FNMATCH_FUNCTION 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_FNMATCH_FUNCTION \- wildcard match callback
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. int fnmatch_callback(void *ptr,
  30. const char *pattern,
  31. const char *string);
  32. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FNMATCH_FUNCTION,
  33. fnmatch_callback);
  34. .SH DESCRIPTION
  35. Pass a pointer to your callback function, which should match the prototype
  36. shown above.
  37. This callback is used for wildcard matching.
  38. Return \fICURL_FNMATCHFUNC_MATCH\fP if pattern matches the string,
  39. \fICURL_FNMATCHFUNC_NOMATCH\fP if not or \fICURL_FNMATCHFUNC_FAIL\fP if an
  40. error occurred.
  41. .SH DEFAULT
  42. NULL == an internal function for wildcard matching.
  43. .SH PROTOCOLS
  44. FTP
  45. .SH EXAMPLE
  46. .nf
  47. static int my_fnmatch(void *clientp,
  48. const char *pattern, const char *string)
  49. {
  50. struct local_stuff *data = (struct local_stuff *)clientp;
  51. if(string_match(pattern, string))
  52. return CURL_FNMATCHFUNC_MATCH;
  53. else
  54. return CURL_FNMATCHFUNC_NOMATCH;
  55. }
  56. {
  57. struct local_stuff local_data;
  58. curl_easy_setopt(curl, CURLOPT_URL, "ftp://ftp.example.com/file*");
  59. curl_easy_setopt(curl, CURLOPT_WILDCARDMATCH, 1L);
  60. curl_easy_setopt(curl, CURLOPT_FNMATCH_FUNCTION, my_fnmatch);
  61. curl_easy_setopt(curl, CURLOPT_FNMATCH_DATA, &local_data);
  62. }
  63. .fi
  64. .SH AVAILABILITY
  65. Added in 7.21.0
  66. .SH RETURN VALUE
  67. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  68. .SH "SEE ALSO"
  69. .BR CURLOPT_FNMATCH_DATA "(3), " CURLOPT_DEBUGFUNCTION "(3), "