5a488251f7
- make DEFAULT sections less repetitive - make historic mentions use HISTORY - generate the protocols section on `# %PROTOCOLS%` instead of guessing where to put it - generate the availability section on `# %AVAILABILITY%` instead of guessing where to put it - make the protocols section more verbose Closes #14227
88 lines
1.9 KiB
Markdown
88 lines
1.9 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_FNMATCH_FUNCTION
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_DEBUGFUNCTION (3)
|
|
- CURLOPT_FNMATCH_DATA (3)
|
|
- CURLOPT_WILDCARDMATCH (3)
|
|
Protocol:
|
|
- FTP
|
|
Added-in: 7.21.0
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_FNMATCH_FUNCTION - wildcard match callback
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#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%
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
extern int string_match(const char *s1, const char *s2);
|
|
|
|
struct local_stuff {
|
|
void *custom;
|
|
};
|
|
static int my_fnmatch(void *clientp,
|
|
const char *pattern, const char *string)
|
|
{
|
|
struct local_stuff *data = clientp;
|
|
printf("my pointer: %p\n", data->custom);
|
|
if(string_match(pattern, string))
|
|
return CURL_FNMATCHFUNC_MATCH;
|
|
else
|
|
return CURL_FNMATCHFUNC_NOMATCH;
|
|
}
|
|
|
|
int main(void)
|
|
{
|
|
struct local_stuff local_data;
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
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);
|
|
curl_easy_perform(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# %AVAILABILITY%
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|