00001 /* 
00002  * File:        recls_ftp.h
00003  *
00004  * Purpose:     Win32-specific header file for the recls API.
00005  *
00006  * Created:     18th August 2003
00007  * Updated:     10th January 2005
00008  *
00009  * Home:        http://recls.org/
00010  *
00011  * Copyright 2003-2005, Matthew Wilson and Synesis Software
00012  * All rights reserved.
00013  *
00014  * Redistribution and use in source and binary forms, with or without 
00015  * modification, are permitted provided that the following conditions are met:
00016  *
00017  * - Redistributions of source code must retain the above copyright notice, this
00018  *   list of conditions and the following disclaimer. 
00019  * - Redistributions in binary form must reproduce the above copyright notice,
00020  *   this list of conditions and the following disclaimer in the documentation
00021  *   and/or other materials provided with the distribution.
00022  * - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of
00023  *   any contributors may be used to endorse or promote products derived from
00024  *   this software without specific prior written permission.
00025  *
00026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00027  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00029  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00030  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00031  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00032  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00033  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00034  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00035  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00036  * POSSIBILITY OF SUCH DAMAGE.
00037  *
00038  * 
00039 
00040 
00041 #ifndef RECLS_INCL_H_RECLS_FTP
00042 #define RECLS_INCL_H_RECLS_FTP
00043 
00044 /* File version */
00045 #ifndef RECLS_DOCUMENTATION_SKIP_SECTION
00046 # define RECLS_VER_H_RECLS_FTP_MAJOR    2
00047 # define RECLS_VER_H_RECLS_FTP_MINOR    0
00048 # define RECLS_VER_H_RECLS_FTP_REVISION 2
00049 # define RECLS_VER_H_RECLS_FTP_EDIT     4
00050 #endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */
00051 
00054 /* 
00055  * Includes
00056  */
00057 
00058 #include "recls.h"
00059 
00060 /* 
00061  * Namespace
00062  */
00063 
00064 #if !defined(RECLS_NO_NAMESPACE)
00065 namespace recls
00066 {
00067 #endif /* !RECLS_NO_NAMESPACE */
00068 
00069 /* 
00070  * Functions
00071  */
00072 
00073 #if defined(RECLS_API_FTP)
00074 # undef RECLS_API_FTP
00075 #endif /* RECLS_API_FTP */
00076 
00077 #if !defined(RECLS_NO_API_FTP)
00078 # ifndef RECLS_PLATFORM_IS_WIN32
00079 #  error The recls-FTP functionality is currently available only in Win32 compilations
00080 # endif /* RECLS_PLATFORM_IS_WIN32 */
00081 
00082 # define RECLS_API_FTP
00083 
00084 
00085 /***************************************
00086  * Search control
00087  */
00088 
00111 RECLS_FNDECL(recls_rc_t) Recls_SearchFtp(       recls_char_t const          *host
00112                                     ,           recls_char_t const          *username
00113                                     ,           recls_char_t const          *password
00114                                     ,           recls_char_t const          *searchRoot
00115                                     ,           recls_char_t const          *pattern
00116                                     ,           recls_uint32_t              flags
00117                                     ,           hrecls_t                    *phSrch);
00118 
00121 #endif /* !RECLS_NO_API_FTP */
00122 
00123 /* 
00124  * Namespace
00125  */
00126 
00127 #if !defined(RECLS_NO_NAMESPACE)
00128 } /* namespace recls */
00129 #endif /* !RECLS_NO_NAMESPACE */
00130 
00131 /* 
00132 
00133 #endif /* !RECLS_INCL_H_RECLS_FTP */
00134 
00135 /*
/include/recls_ftp.h
