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:     8th June 2004
00008  *
00009  * Author:      Matthew Wilson, Synesis Software Pty Ltd.
00010  *
00011  * License:     (Licensed under the Synesis Software Standard Source License)
00012  *
00013  *              Copyright (C) 2002-2004, Synesis Software Pty Ltd.
00014  *
00015  *              All rights reserved.
00016  *
00017  *              www:        http://www.synesis.com.au/software
00018  *                          http://www.recls.org/
00019  *
00020  *              email:      submissions@recls.org  for submissions
00021  *                          admin@recls.org        for other enquiries
00022  *
00023  *              Redistribution and use in source and binary forms, with or
00024  *              without modification, are permitted provided that the following
00025  *              conditions are met:
00026  *
00027  *              (i) Redistributions of source code must retain the above
00028  *              copyright notice and contact information, this list of
00029  *              conditions and the following disclaimer.
00030  *
00031  *              (ii) Any derived versions of this software (howsoever modified)
00032  *              remain the sole property of Synesis Software.
00033  *
00034  *              (iii) Any derived versions of this software (howsoever modified)
00035  *              remain subject to all these conditions.
00036  *
00037  *              (iv) Neither the name of Synesis Software nor the names of any
00038  *              subdivisions, employees or agents of Synesis Software, nor the
00039  *              names of any other contributors to this software may be used to
00040  *              endorse or promote products derived from this software without
00041  *              specific prior written permission.
00042  *
00043  *              This source code is provided by Synesis Software "as is" and any
00044  *              warranties, whether expressed or implied, including, but not
00045  *              limited to, the implied warranties of merchantability and
00046  *              fitness for a particular purpose are disclaimed. In no event
00047  *              shall the Synesis Software be liable for any direct, indirect,
00048  *              incidental, special, exemplary, or consequential damages
00049  *              (including, but not limited to, procurement of substitute goods
00050  *              or services; loss of use, data, or profits; or business
00051  *              interruption) however caused and on any theory of liability,
00052  *              whether in contract, strict liability, or tort (including
00053  *              negligence or otherwise) arising in any way out of the use of
00054  *              this software, even if advised of the possibility of such
00055  *              damage.
00056  *
00057  * 
00058 
00059 
00060 #ifndef RECLS_INCL_H_RECLS_FTP
00061 #define RECLS_INCL_H_RECLS_FTP
00062 
00063 /* File version */
00064 #ifndef RECLS_DOCUMENTATION_SKIP_SECTION
00065 # define RECLS_VER_H_RECLS_FTP_MAJOR    1
00066 # define RECLS_VER_H_RECLS_FTP_MINOR    0
00067 # define RECLS_VER_H_RECLS_FTP_REVISION 1
00068 # define RECLS_VER_H_RECLS_FTP_EDIT     2
00069 #endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */
00070 
00073 /* 
00074  * Includes
00075  */
00076 
00077 #include "recls.h"
00078 
00079 /* 
00080  * Namespace
00081  */
00082 
00083 #if !defined(RECLS_NO_NAMESPACE)
00084 namespace recls
00085 {
00086 #endif /* !RECLS_NO_NAMESPACE */
00087 
00088 /* 
00089  * Functions
00090  */
00091 
00092 #if defined(RECLS_API_FTP)
00093 # undef RECLS_API_FTP
00094 #endif /* RECLS_API_FTP */
00095 
00096 #if !defined(RECLS_NO_API_FTP)
00097 # ifndef RECLS_PLATFORM_IS_WIN32
00098 #  error The recls-FTP functionality is currently available only in Win32 compilations
00099 # endif /* RECLS_PLATFORM_IS_WIN32 */
00100 
00101 # define RECLS_API_FTP
00102 
00103 
00104 /***************************************
00105  * Search control
00106  */
00107 
00130 RECLS_FNDECL(recls_rc_t) Recls_SearchFtp(       recls_char_t const          *host
00131                                     ,           recls_char_t const          *username
00132                                     ,           recls_char_t const          *password
00133                                     ,           recls_char_t const          *searchRoot
00134                                     ,           recls_char_t const          *pattern
00135                                     ,           recls_uint32_t              flags
00136                                     ,           hrecls_t                    *phSrch);
00137 
00140 #endif /* !RECLS_NO_API_FTP */
00141 
00142 /* 
00143  * Namespace
00144  */
00145 
00146 #if !defined(RECLS_NO_NAMESPACE)
00147 } /* namespace recls */
00148 #endif /* !RECLS_NO_NAMESPACE */
00149 
00150 /* 
00151 
00152 #endif /* !RECLS_INCL_H_RECLS_FTP */
00153 
00154 /*
/API/include/recls_ftp.h
