C/C++ User's Journal STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ... ATLSTL - where the Standard Template Library meets the Active Template Library COMSTL - where the Standard Template Library meets the Component Object Model
Synesis Software InetSTL - where the Standard Template Library meets the Internet UNIXSTL - Template Software for the UNIX Operating System WinSTL - where the Standard Template Library meets the Win32 API

recls/ftp.h

Go to the documentation of this file.
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:     16th June 2006
00008  *
00009  * Home:        http://recls.org/
00010  *
00011  * Copyright (c) 2003-2006, 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_RECLS_H_FTP
00042 #define RECLS_INCL_RECLS_H_FTP
00043 
00044 /* File version */
00045 #ifndef RECLS_DOCUMENTATION_SKIP_SECTION
00046 # define RECLS_VER_RECLS_H_FTP_MAJOR    3
00047 # define RECLS_VER_RECLS_H_FTP_MINOR    1
00048 # define RECLS_VER_RECLS_H_FTP_REVISION 1
00049 # define RECLS_VER_RECLS_H_FTP_EDIT     8
00050 #endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */
00051 
00057 /* /////////////////////////////////////////////////////////////////////////////
00058  * Includes
00059  */
00060 
00061 #include <recls/recls.h>
00062 
00063 /* /////////////////////////////////////////////////////////////////////////////
00064  * Namespace
00065  */
00066 
00067 #if !defined(RECLS_NO_NAMESPACE)
00068 namespace recls
00069 {
00070 #endif /* !RECLS_NO_NAMESPACE */
00071 
00072 /* /////////////////////////////////////////////////////////////////////////////
00073  * Functions
00074  */
00075 
00076 #if defined(RECLS_API_FTP)
00077 # undef RECLS_API_FTP
00078 #endif /* RECLS_API_FTP */
00079 
00080 #if !defined(RECLS_NO_API_FTP)
00081 # ifndef RECLS_PLATFORM_IS_WIN32
00082 #  error The recls-FTP functionality is currently available only in Win32 compilations
00083 # endif /* RECLS_PLATFORM_IS_WIN32 */
00084 
00085 # define RECLS_API_FTP
00086 
00087 
00088 /***************************************
00089  * Search control
00090  */
00091 
00116 RECLS_FNDECL(recls_rc_t) Recls_SearchFtp(   recls_char_t const  *host
00117                                     ,       recls_char_t const  *username
00118                                     ,       recls_char_t const  *password
00119                                     ,       recls_char_t const  *searchRoot
00120                                     ,       recls_char_t const  *pattern
00121                                     ,       recls_uint32_t      flags
00122                                     ,       hrecls_t            *phSrch);
00123 
00126 #endif /* !RECLS_NO_API_FTP */
00127 
00128 /* /////////////////////////////////////////////////////////////////////////////
00129  * Namespace
00130  */
00131 
00132 #if !defined(RECLS_NO_NAMESPACE)
00133 } /* namespace recls */
00134 #endif /* !RECLS_NO_NAMESPACE */
00135 
00136 /* /////////////////////////////////////////////////////////////////////////////
00137  * Inclusion
00138  */
00139 
00140 #ifdef RECLS_CF_PRAGMA_ONCE_SUPPORT
00141 # pragma once
00142 #endif /* RECLS_CF_PRAGMA_ONCE_SUPPORT */
00143 
00144 /* ////////////////////////////////////////////////////////////////////////// */
00145 
00146 #endif /* !RECLS_INCL_RECLS_H_FTP */
00147 
00148 /* ////////////////////////////////////////////////////////////////////////// */

recls Library documentation © Synesis Software Pty Ltd, 2001-2006