docs/libcurl/opts/CURLOPT_FNMATCH_FUNCTION.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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.haxx.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 matching function callback
  26 .SH SYNOPSIS
  27 .nf
  28 #include <curl/curl.h>
  29
  30 int fnmatch_callback(void *ptr,
  31                      const char *pattern,
  32                      const char *string);
  33
  34 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FNMATCH_FUNCTION,
  35                           fnmatch_callback);
  36 .SH DESCRIPTION
  37 Pass a pointer to your callback function, which should match the prototype
  38 shown above.
  39
  40 This callback is used for wildcard matching.
  41
  42 Return \fICURL_FNMATCHFUNC_MATCH\fP if pattern matches the string,
  43 \fICURL_FNMATCHFUNC_NOMATCH\fP if not or \fICURL_FNMATCHFUNC_FAIL\fP if an
  44 error occurred.
  45 .SH DEFAULT
  46 NULL == an internal function for wildcard matching.
  47 .SH PROTOCOLS
  48 FTP
  49 .SH EXAMPLE
  50 TODO
  51 .SH AVAILABILITY
  52 Added in 7.21.0
  53 .SH RETURN VALUE
  54 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  55 .SH "SEE ALSO"
  56 .BR CURLOPT_FNMATCH_DATA "(3), " CURLOPT_DEBUGFUNCTION "(3), "