docs/libcurl/opts/CURLOPT_FNMATCH_DATA.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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_DATA 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_FNMATCH_DATA \- custom pointer to fnmatch callback
  27 .SH SYNOPSIS
  28 .nf
  29 #include <curl/curl.h>
  30
  31 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FNMATCH_DATA,
  32                           void *pointer);
  33 .SH DESCRIPTION
  34 Pass a pointer that will be untouched by libcurl and passed as the ptr
  35 argument to the \fICURLOPT_FNMATCH_FUNCTION(3)\fP.
  36 .SH DEFAULT
  37 NULL
  38 .SH PROTOCOLS
  39 FTP
  40 .SH EXAMPLE
  41 .nf
  42 static int my_fnmatch(void *clientp,
  43                       const char *pattern, const char *string)
  44 {
  45   struct local_stuff *data = (struct local_stuff *)clientp;
  46   if(string_match(pattern, string))
  47     return CURL_FNMATCHFUNC_MATCH;
  48   else
  49     return CURL_FNMATCHFUNC_NOMATCH;
  50 }
  51
  52 {
  53   struct local_stuff local_data;
  54   curl_easy_setopt(curl, CURLOPT_URL, "ftp://ftp.example.com/file*");
  55   curl_easy_setopt(curl, CURLOPT_WILDCARDMATCH, 1L);
  56   curl_easy_setopt(curl, CURLOPT_FNMATCH_FUNCTION, my_fnmatch);
  57   curl_easy_setopt(curl, CURLOPT_FNMATCH_DATA, &local_data);
  58 }
  59 .fi
  60 .SH AVAILABILITY
  61 Added in 7.21.0
  62 .SH RETURN VALUE
  63 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  64 .SH "SEE ALSO"
  65 .BR CURLOPT_FNMATCH_FUNCTION "(3), " CURLOPT_WILDCARDMATCH "(3), "