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/internal/retcodes.h

Go to the documentation of this file.
00001 /* /////////////////////////////////////////////////////////////////////////////
00002  * File:        recls/internal/retcodes.h
00003  *
00004  * Purpose:     Return codes for the  recls API.
00005  *
00006  * Created:     15th 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 #if !defined(RECLS_INCL_RECLS_H_RECLS) && \
00042     !defined(RECLS_DOCUMENTATION_SKIP_SECTION)
00043 # error recls/retcodes.h cannot be included directly. Include recls/recls.h
00044 #else
00045 
00046 /* File version */
00047 #ifndef RECLS_DOCUMENTATION_SKIP_SECTION
00048 # define RECLS_VER_RECLS_INTERNAL_H_RETCODES_MAJOR      3
00049 # define RECLS_VER_RECLS_INTERNAL_H_RETCODES_MINOR      1
00050 # define RECLS_VER_RECLS_INTERNAL_H_RETCODES_REVISION   1
00051 # define RECLS_VER_RECLS_INTERNAL_H_RETCODES_EDIT       27
00052 #endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */
00053 
00060 /* /////////////////////////////////////////////////////////////////////////////
00061  * Namespace
00062  */
00063 
00064 #if !defined(RECLS_NO_NAMESPACE)
00065 namespace recls
00066 {
00067 #endif /* !RECLS_NO_NAMESPACE */
00068 
00069 /* /////////////////////////////////////////////////////////////////////////////
00070  * Helper macros
00071  */
00072 
00073 #ifndef RECLS_DOCUMENTATION_SKIP_SECTION
00074 # define RECLS_CAST_OPERATOR_TRIGRAPH_SPLITTER  /* Just to make doubly sure that we can't get a <:: trigraph from a globally qualified type */
00075 # ifdef __cplusplus
00076 #  define _RECLS_STATIC_CAST(t, v)              (static_cast<RECLS_CAST_OPERATOR_TRIGRAPH_SPLITTER t>(v))
00077 # else /* ? __cplusplus */
00078 #  define _RECLS_STATIC_CAST(t, v)              ((t)(v))
00079 # endif /* __cplusplus */
00080 #endif /* !RECLS_DOCUMENTATION_SKIP_SECTION */
00081 
00082 /* /////////////////////////////////////////////////////////////////////////////
00083  * Error codes
00084  */
00085 
00093 #define RECLS_RC_SEARCH_NO_CURRENT          _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1001)
00094 
00095 #define RECLS_RC_INVALID_DIRECTORY          _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1002)
00096 
00097 #define RECLS_RC_NO_MORE_DATA               _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1003)
00098 
00099 #define RECLS_RC_OUT_OF_MEMORY              _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1004)
00100 
00101 #define RECLS_RC_NOT_IMPLEMENTED            _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1005)
00102 
00103 #define RECLS_RC_INVALID_SEARCH_TYPE        _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1006)
00104 
00105 #define RECLS_RC_INVALID_SEARCH_PROTOCOL    _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1007)
00106 
00107 #define RECLS_RC_UNEXPECTED                 _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1008)
00108 
00109 #define RECLS_RC_DOT_RECURSIVE_SEARCH       _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1009)
00110 
00111 #define RECLS_RC_SEARCH_CANCELLED           _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1010)
00112 
00113 #define RECLS_RC_FTP_INIT_FAILED            _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1011)
00114 
00115 #define RECLS_RC_FTP_CONNECTION_FAILED      _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1012)
00116 
00117 #define RECLS_RC_WRONG_ENTRY_TYPE           _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1013)
00118 
00119 #define RECLS_RC_CANNOT_STAT_ROOT           _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1014)
00120 
00121 #define RECLS_RC_PATH_LIMIT_EXCEEDED        _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1015)
00122 
00123 #define RECLS_RC_USER_CANCELLED_SEARCH      _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1016)
00124 
00125 #define RECLS_RC_NO_HOME                    _RECLS_STATIC_CAST(RECLS_QUAL(recls_rc_t), -1 - 1017)
00126 
00129 /* /////////////////////////////////////////////////////////////////////////////
00130  * Namespace
00131  */
00132 
00133 #if !defined(RECLS_NO_NAMESPACE)
00134 } /* namespace recls */
00135 #endif /* !RECLS_NO_NAMESPACE */
00136 
00137 /* ////////////////////////////////////////////////////////////////////////// */
00138 
00139 #endif /* !RECLS_INCL_RECLS_H_RECLS */
00140 
00141 /* ////////////////////////////////////////////////////////////////////////// */

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