Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_FNMATCH_FUNCTION.3, revision 1.1
1.1 ! misho 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_FUNCTION 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
! 24:
! 25: .SH NAME
! 26: CURLOPT_FNMATCH_FUNCTION \- wildcard matching function callback
! 27: .SH SYNOPSIS
! 28: .nf
! 29: #include <curl/curl.h>
! 30:
! 31: int fnmatch_callback(void *ptr,
! 32: const char *pattern,
! 33: const char *string);
! 34:
! 35: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FNMATCH_FUNCTION,
! 36: fnmatch_callback);
! 37: .SH DESCRIPTION
! 38: Pass a pointer to your callback function, which should match the prototype
! 39: shown above.
! 40:
! 41: This callback is used for wildcard matching.
! 42:
! 43: Return \fICURL_FNMATCHFUNC_MATCH\fP if pattern matches the string,
! 44: \fICURL_FNMATCHFUNC_NOMATCH\fP if not or \fICURL_FNMATCHFUNC_FAIL\fP if an
! 45: error occurred.
! 46: .SH DEFAULT
! 47: NULL == an internal function for wildcard matching.
! 48: .SH PROTOCOLS
! 49: FTP
! 50: .SH EXAMPLE
! 51: .nf
! 52: static int my_fnmatch(void *clientp,
! 53: const char *pattern, const char *string)
! 54: {
! 55: struct local_stuff *data = (struct local_stuff *)clientp;
! 56: if(string_match(pattern, string))
! 57: return CURL_FNMATCHFUNC_MATCH;
! 58: else
! 59: return CURL_FNMATCHFUNC_NOMATCH;
! 60: }
! 61:
! 62: {
! 63: struct local_stuff local_data;
! 64: curl_easy_setopt(curl, CURLOPT_URL, "ftp://ftp.example.com/file*");
! 65: curl_easy_setopt(curl, CURLOPT_WILDCARDMATCH, 1L);
! 66: curl_easy_setopt(curl, CURLOPT_FNMATCH_FUNCTION, my_fnmatch);
! 67: curl_easy_setopt(curl, CURLOPT_FNMATCH_DATA, &local_data);
! 68: }
! 69: .fi
! 70: .SH AVAILABILITY
! 71: Added in 7.21.0
! 72: .SH RETURN VALUE
! 73: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
! 74: .SH "SEE ALSO"
! 75: .BR CURLOPT_FNMATCH_DATA "(3), " CURLOPT_DEBUGFUNCTION "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>