---

error.h

Go to the documentation of this file.

/***************************************************************************
 $RCSfile: error.h,v $
                             -------------------
    cvs         : $Id: error.h,v 1.22 2003/06/07 20:22:19 aquamaniac Exp $
    begin       : Sun Nov 18 2001
    copyright   : (C) 2001 by Martin Preuss
    email       : openhbci@aquamaniac.de

 ***************************************************************************
 *                                                                         *
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 *                                                                         *
 ***************************************************************************/


#ifndef HBCIERROR_H
#define HBCIERROR_H

#include <openhbci/dllimport.h>


typedef enum ErrorLevel {
    ERROR_LEVEL_NONE     = 0,
    ERROR_LEVEL_EASY,
    ERROR_LEVEL_NORMAL,
    ERROR_LEVEL_CRITICAL,
    ERROR_LEVEL_PANIC,
    ERROR_LEVEL_INTERNAL
} ErrorLevel;

typedef enum ErrorAdvise {
    ERROR_ADVISE_DONTKNOW = 0,
    ERROR_ADVISE_IGNORE   = 1,
    ERROR_ADVISE_RETRY    = 2,
    ERROR_ADVISE_ABORT    = 100,
    ERROR_ADVISE_SHUTDOWN = 101
} ErrorAdvise;

enum ErrorCodes {
    HBCI_ERROR_CODE_UNKNOWN = 0,
    HBCI_ERROR_CODE_PIN_WRONG = 100,
    HBCI_ERROR_CODE_PIN_WRONG_0,
    HBCI_ERROR_CODE_PIN_WRONG_1,
    HBCI_ERROR_CODE_PIN_WRONG_2,
    HBCI_ERROR_CODE_PIN_ABORTED,
    HBCI_ERROR_CODE_PIN_TOO_SHORT,
    HBCI_ERROR_CODE_CARD_DESTROYED,
    HBCI_ERROR_CODE_FILE_NOT_FOUND,
    HBCI_ERROR_CODE_NO_CARD,
    HBCI_ERROR_CODE_JOB_NOT_SUPPORTED,
    HBCI_ERROR_CODE_SOCKET_NO_CONNECT,
    HBCI_ERROR_CODE_SOCKET_ERROR_TIMEOUT,
    HBCI_ERROR_CODE_SOCKET_ERROR_INTERRUPT,
    HBCI_ERROR_CODE_SOCKET_ERROR_UNKNOWN,
    HBCI_ERROR_CODE_WRONG_MEDIUM,
    HBCI_ERROR_CODE_LIBRARY,
    HBCI_ERROR_CODE_EXISTS,
    HBCI_ERROR_CODE_INEXISTENT,
    HBCI_ERROR_CODE_INVALID,
    HBCI_ERROR_CODE_MEDIUM,
    HBCI_ERROR_CODE_UNSUPPORTED,
    HBCI_ERROR_CODE_BAD_MEDIUM,
    HBCI_ERROR_CODE_USER_ABORT,
    HBCI_ERROR_CODE_UNKNOWN_PROPERTY,
    HBCI_ERROR_CODE_INVALID_VALUE,
    HBCI_ERROR_CODE_PROPERTY_READONLY
};

/* Make this header able to be included by both C++ and C. First the
   class definition for the C++ library. */
#ifdef __cplusplus
#include <string>

namespace HBCI {
using namespace std;
class Error;

class DLLIMPORT Error {
private:
    string _where;
    ErrorLevel _level;
    int _code;
    ErrorAdvise _advise;
    string _message;
    string _info;
    string _reportedFrom;

public:
    Error();

    Error(string where,
          string message,
          int code);

    Error(string where,
          ErrorLevel level,
          int code,
          ErrorAdvise advise,
          string message,
          string info="");

    Error(const string &where,
          const Error &err);

    ~Error();

    bool isOk() const { return _level==ERROR_LEVEL_NONE; };

    const string& where() const {return _where; };

    int code() const { return _code; };

    const string& message() const { return _message;};

    ErrorLevel level() const { return _level; };

    ErrorAdvise advise() const { return _advise; };

    const string& info() const { return _info; };

    string errorString() const;


};

} /* namespace HBCI */

typedef struct HBCI::Error HBCI_Error;

/* Now the typedefs and function prototypes for C. */
#else /* __cplusplus */
typedef struct HBCI_Error HBCI_Error;
#endif /* __cplusplus */

#ifdef __cplusplus
extern "C" {
#endif

    extern HBCI_Error* HBCI_Error_new(const char* where,
                                  ErrorLevel level,
                                  int code,
                                  ErrorAdvise advise,
                                  const char* error,
                                  const char* info);

    extern void HBCI_Error_delete(HBCI_Error* e);

    extern int HBCI_Error_isOk(const HBCI_Error * );

    extern const char * HBCI_Error_where(const HBCI_Error * );

    extern int HBCI_Error_code(const HBCI_Error * );

    extern ErrorLevel HBCI_Error_level(const HBCI_Error * );

    extern ErrorAdvise HBCI_Error_advise(const HBCI_Error * ); 

    extern const char * HBCI_Error_message(const HBCI_Error * );

    extern const char * HBCI_Error_info(const HBCI_Error * ); 

    extern char * HBCI_Error_errorString(const HBCI_Error * );

#ifdef __cplusplus
}
#endif


#endif

---