DragonFly On-Line Manual Pages

Search: Section:  

CURLOPT_FNMATCH_FUNCTION(3)         libcurl        CURLOPT_FNMATCH_FUNCTION(3)


NAME

       CURLOPT_FNMATCH_FUNCTION - wildcard match callback


SYNOPSIS

       #include <curl/curl.h>

       int fnmatch_callback(void *ptr,
                            const char *pattern,
                            const char *string);

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FNMATCH_FUNCTION,
                                 fnmatch_callback);


DESCRIPTION

       Pass a pointer to your callback function, which should match the
       prototype shown above.

       This callback is used for wildcard matching.

       Return CURL_FNMATCHFUNC_MATCH if pattern matches the string,
       CURL_FNMATCHFUNC_NOMATCH if not or CURL_FNMATCHFUNC_FAIL if an error
       occurred.


DEFAULT

       NULL == an internal function for wildcard matching.


PROTOCOLS

       FTP


EXAMPLE

       static int my_fnmatch(void *clientp,
                             const char *pattern, const char *string)
       {
         struct local_stuff *data = (struct local_stuff *)clientp;
         if(string_match(pattern, string))
           return CURL_FNMATCHFUNC_MATCH;
         else
           return CURL_FNMATCHFUNC_NOMATCH;
       }

       {
         struct local_stuff local_data;
         curl_easy_setopt(curl, CURLOPT_URL, "ftp://ftp.example.com/file*");
         curl_easy_setopt(curl, CURLOPT_WILDCARDMATCH, 1L);
         curl_easy_setopt(curl, CURLOPT_FNMATCH_FUNCTION, my_fnmatch);
         curl_easy_setopt(curl, CURLOPT_FNMATCH_DATA, &local_data);
       }


AVAILABILITY

       Added in 7.21.0


RETURN VALUE

       Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION
       if not.


SEE ALSO

       CURLOPT_FNMATCH_DATA(3), CURLOPT_DEBUGFUNCTION(3),

ibcurl 8.1.2                    April 26, 2023     CURLOPT_FNMATCH_FUNCTION(3)

Search: Section: