Main Page Modules Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages

error.h File Reference

Definitions of HBCI::Error and its C wrapper HBCI_Error. More...

#include <openhbci/dllimport.h>
#include <string>

Go to the source code of this file.

Namespaces

namespace HBCI

Typedefs

typedef enum ErrorLevel ErrorLevel

typedef enum ErrorAdvise ErrorAdvise

typedef HBCI::Error HBCI_Error

Enumerations

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

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

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
}

Functions

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

void HBCI_Error_delete (HBCI_Error *e)

int HBCI_Error_isOk (const HBCI_Error *)

const char * HBCI_Error_where (const HBCI_Error *)

int HBCI_Error_code (const HBCI_Error *)

ErrorLevel HBCI_Error_level (const HBCI_Error *)

ErrorAdvise HBCI_Error_advise (const HBCI_Error *)

const char * HBCI_Error_message (const HBCI_Error *)

const char * HBCI_Error_info (const HBCI_Error *)

char * HBCI_Error_errorString (const HBCI_Error *)

Detailed Description

Definitions of HBCI::Error and its C wrapper HBCI_Error.

Typedef Documentation

typedef enum ErrorAdvise ErrorAdvise

Proposed reaction on this error

typedef enum ErrorLevel ErrorLevel

Severity Level of this error

typedef struct HBCI::Error HBCI_Error

Enumeration Type Documentation

enum ErrorAdvise

Proposed reaction on this error
Enumeration values:

ERROR_ADVISE_DONTKNOW Unknown, unspecified

ERROR_ADVISE_IGNORE Ignore this error

ERROR_ADVISE_RETRY Retry the last operation

ERROR_ADVISE_ABORT It does not make sense to continue or retry

ERROR_ADVISE_SHUTDOWN Stop the program

enum ErrorCodes

Some error codes for very specific errors
Enumeration values:

HBCI_ERROR_CODE_UNKNOWN Unknown, unspecified

HBCI_ERROR_CODE_PIN_WRONG PIN was wrong (no info about retry count)

HBCI_ERROR_CODE_PIN_WRONG_0 PIN wrong, no errorneous pin input left

HBCI_ERROR_CODE_PIN_WRONG_1 PIN wrong, one errorneous pin input left

HBCI_ERROR_CODE_PIN_WRONG_2 PIN wrong, two errorneous pin input left

HBCI_ERROR_CODE_PIN_ABORTED PIN dialog was aborted by user

HBCI_ERROR_CODE_PIN_TOO_SHORT The PIN entered was too short

HBCI_ERROR_CODE_CARD_DESTROYED Wrong pin entered too often, card is unusable

HBCI_ERROR_CODE_FILE_NOT_FOUND Medium file (keyfile) was not found

HBCI_ERROR_CODE_NO_CARD No chip card inserted

HBCI_ERROR_CODE_JOB_NOT_SUPPORTED A specific HBCI job is not supported by the institute, i.e. they won't do this kind of job. Either the BPD said that they don't support this job, or they signalled an error when the textkey was sent to them.

HBCI_ERROR_CODE_SOCKET_NO_CONNECT The socket connection failed -- this probably means that the bank server currently refuses connections.

HBCI_ERROR_CODE_SOCKET_ERROR_TIMEOUT Timeout during socket connect

HBCI_ERROR_CODE_SOCKET_ERROR_INTERRUPT System call interrupted -- please try again

HBCI_ERROR_CODE_SOCKET_ERROR_UNKNOWN general socket error

HBCI_ERROR_CODE_WRONG_MEDIUM wrong medium inserted

HBCI_ERROR_CODE_LIBRARY error with library loader

HBCI_ERROR_CODE_EXISTS whenever there is a double entry in any kind of list

HBCI_ERROR_CODE_INEXISTENT whenever something does not exist

HBCI_ERROR_CODE_INVALID invalid argument

HBCI_ERROR_CODE_MEDIUM general medium error

HBCI_ERROR_CODE_UNSUPPORTED method/function not supported

HBCI_ERROR_CODE_BAD_MEDIUM this is used when MediumPlugin::mediumCheck finds an unsupported medium

HBCI_ERROR_CODE_USER_ABORT user aborted an operation

HBCI_ERROR_CODE_UNKNOWN_PROPERTY a given property is not supported by the medium

HBCI_ERROR_CODE_INVALID_VALUE Medium::setProperty called with an illegal value

HBCI_ERROR_CODE_PROPERTY_READONLY Medium::setProperty called for a readonly property

enum ErrorLevel

Severity Level of this error
Enumeration values:

ERROR_LEVEL_NONE no error

ERROR_LEVEL_EASY unimportant error, warning

ERROR_LEVEL_NORMAL normal error

ERROR_LEVEL_CRITICAL critical error

ERROR_LEVEL_PANIC very, very critical error

ERROR_LEVEL_INTERNAL internal error

Function Documentation

ErrorAdvise HBCI_Error_advise ( const HBCI_Error * )

Returns an advise upon this error (0 if no advise)
Author:
Christian Stimming<stimming@tuhh.de>

int HBCI_Error_code ( const HBCI_Error * )

Returns the error code. Some of these codes (starting from integer number 100) have been specified for very specific conditions in OpenHBCI now -- see ErrorCodes.

See also:
ErrorCodes
Author:
Christian Stimming<stimming@tuhh.de>

void HBCI_Error_delete ( HBCI_Error * e )

Destructor.
Author:
Christian Stimming <stimming@tuhh.de>

char* HBCI_Error_errorString ( const HBCI_Error * )

Returns a short error string containing all important information.

Note:
This char* pointer will be owned by the caller and has to be free'd by the callee when no longer needed.
Author:
Christian Stimming<stimming@tuhh.de>

const char* HBCI_Error_info ( const HBCI_Error * )

Returns additional info about the error. The const char* pointer should *not* be free'd.
Author:
Christian Stimming<stimming@tuhh.de>

int HBCI_Error_isOk ( const HBCI_Error * )

Tells you if this object shows an error or if all was ok.
Returns :
non-zero if there was no error, zero otherwise
Author:
Christian Stimming<stimming@tuhh.de>

ErrorLevel HBCI_Error_level ( const HBCI_Error * )

Returns the severity of the error.
Author:
Christian Stimming<stimming@tuhh.de>

const char* HBCI_Error_message ( const HBCI_Error * )

Returns the error message itself (e.g. "Bad filename").
The const char* pointer should *not* be free'd.
Author:
Christian Stimming<stimming@tuhh.de>

HBCI_Error* HBCI_Error_new ( const char * where,

ErrorLevel level,

int code,

ErrorAdvise advise,

const char * error,

const char * info

)

C wrapper for constructor.
Author:
Christian Stimming <stimming@tuhh.de>

const char* HBCI_Error_where ( const HBCI_Error * )

Return the location of the error, e.g. "c_error::c_error()".
The const char* pointer should *not* be free'd.
Author:
Christian Stimming<stimming@tuhh.de>

Generated on Mon Jun 23 13:41:08 2003 for openhbci by

1.2.17


Namespaces
namespace	HBCI
Typedefs
typedef enum ErrorLevel	ErrorLevel
typedef enum ErrorAdvise	ErrorAdvise
typedef HBCI::Error	HBCI_Error
Enumerations
enum	ErrorLevel { ERROR_LEVEL_NONE = 0, ERROR_LEVEL_EASY, ERROR_LEVEL_NORMAL, ERROR_LEVEL_CRITICAL, ERROR_LEVEL_PANIC, ERROR_LEVEL_INTERNAL }
enum	ErrorAdvise { ERROR_ADVISE_DONTKNOW = 0, ERROR_ADVISE_IGNORE = 1, ERROR_ADVISE_RETRY = 2, ERROR_ADVISE_ABORT = 100, ERROR_ADVISE_SHUTDOWN = 101 }
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 }
Functions
HBCI_Error *	HBCI_Error_new (const char where, ErrorLevel level, int code, ErrorAdvise advise, const char error, const char *info)
void	HBCI_Error_delete (HBCI_Error *e)
int	HBCI_Error_isOk (const HBCI_Error *)
const char *	HBCI_Error_where (const HBCI_Error *)
int	HBCI_Error_code (const HBCI_Error *)
ErrorLevel	HBCI_Error_level (const HBCI_Error *)
ErrorAdvise	HBCI_Error_advise (const HBCI_Error *)
const char *	HBCI_Error_message (const HBCI_Error *)
const char *	HBCI_Error_info (const HBCI_Error *)
char *	HBCI_Error_errorString (const HBCI_Error *)