---

bank.h File Reference

HBCI::Bank, its C wrapper HBCI_Bank. Also HBCI::instituteMessage but no C wrappers. More...

#include <string>
#include <list>
#include <openhbci/dllimport.h>
#include <openhbci/pointer.h>
#include <openhbci/hbci.h>
#include <openhbci/date.h>
#include <openhbci/account.h>
#include <openhbci/user.h>
#include <openhbci/listwrappers.h>
#include <openhbci/bpdjob.h>

Go to the source code of this file.

Namespaces
namespace	HBCI
C wrapper for list of Banks
typedef void *(*	list_HBCI_Bank_cb )(const HBCI_Bank *bank, void *user_data)
void	list_HBCI_Bank_delete (list_HBCI_Bank *l)
void	list_HBCI_Bank_iter_delete (list_HBCI_Bank_iter *l)
int	list_HBCI_Bank_size (const list_HBCI_Bank *l)
list_HBCI_Bank_iter *	list_HBCI_Bank_begin (const list_HBCI_Bank *l)
list_HBCI_Bank_iter *	list_HBCI_Bank_end (const list_HBCI_Bank *l)
const HBCI_Bank *	list_HBCI_Bank_iter_get (const list_HBCI_Bank_iter *l)
void	list_HBCI_Bank_iter_next (list_HBCI_Bank_iter *l)
int	list_HBCI_Bank_iter_equal (const list_HBCI_Bank_iter *l1, const list_HBCI_Bank_iter *l2)
void *	list_HBCI_Bank_foreach (const list_HBCI_Bank *list, list_HBCI_Bank_cb func, void *user_data)
C wrapper for list of HBCI_instituteMessage
typedef void *(*	list_HBCI_instituteMessage_cb )(HBCI_instituteMessage *msg, void *user_data)
void *	list_HBCI_instituteMessage_foreach (const list_HBCI_instituteMessage *list, list_HBCI_instituteMessage_cb func, void *user_data)
Casts
const HBCI_Hbci *	HBCI_Bank_hbci (const HBCI_Bank *h)
Bank identification
int	HBCI_Bank_countryCode (const HBCI_Bank *h)
void	HBCI_Bank_setCountryCode (HBCI_Bank *h, int i)
const char *	HBCI_Bank_bankCode (const HBCI_Bank *h)
void	HBCI_Bank_setBankCode (HBCI_Bank *h, const char *s)
Bank Information
const char *	HBCI_Bank_name (const HBCI_Bank *h)
const list_HBCI_instituteMessage *	HBCI_Bank_messages (const HBCI_Bank *h)
Object retrieval
const list_HBCI_Account *	HBCI_Bank_accounts (const HBCI_Bank *h)
const list_HBCI_User *	HBCI_Bank_users (const HBCI_Bank *h)
const HBCI_User *	HBCI_Bank_findUser (const HBCI_Bank *h, const char *userid)
const HBCI_Account *	HBCI_Bank_findAccount (const HBCI_Bank *h, const char *nr)
const HBCI_Account *	HBCI_Bank_findAccountWSuf (const HBCI_Bank *h, const char *nr, const char *suf)
Manage Objects
HBCI_Error *	HBCI_Bank_addAccount (HBCI_Bank *h, HBCI_Account *a, int autoDelete)
HBCI_Error *	HBCI_Bank_addUser (HBCI_Bank *h, HBCI_User *c, int autoDelete)
Communication Parameters
const char *	HBCI_Bank_addr (const HBCI_Bank *h)
void	HBCI_Bank_setAddr (HBCI_Bank *h, const char *s)
int	HBCI_Bank_type (const HBCI_Bank *h)
void	HBCI_Bank_setType (HBCI_Bank *h, int i)
HBCI Version
int	HBCI_Bank_hbciVersion (const HBCI_Bank *h)
void	HBCI_Bank_setHbciVersion (HBCI_Bank *h, int v)
int	HBCI_Bank_bpdVersion (const HBCI_Bank *h)
void	HBCI_Bank_setBPDVersion (HBCI_Bank *h, int i)
list_int *	HBCI_Bank_supportedVersions (const HBCI_Bank *h)
const HBCI_bpdJob *	HBCI_Bank_findJob (const HBCI_Bank *h, const char *segname)
const HBCI_bpdJob *	HBCI_Bank_findJob_minv (const HBCI_Bank *h, const char *segname, int minv)
const HBCI_bpdJob *	HBCI_Bank_findJob_maxv (const HBCI_Bank *h, const char *segname, int minv, int maxv)
HBCI_instituteMessage wrappers
const HBCI_Date *	HBCI_instituteMessage_date (const HBCI_instituteMessage *m)
const HBCI_Time *	HBCI_instituteMessage_time (const HBCI_instituteMessage *m)
const char *	HBCI_instituteMessage_subject (const HBCI_instituteMessage *m)
const char *	HBCI_instituteMessage_text (const HBCI_instituteMessage *m)
int	HBCI_instituteMessage_country (const HBCI_instituteMessage *m)
const char *	HBCI_instituteMessage_bankCode (const HBCI_instituteMessage *m)
int	HBCI_instituteMessage_read (const HBCI_instituteMessage *m)
void	HBCI_instituteMessage_setRead (HBCI_instituteMessage *m, int b)
Typedefs
typedef HBCI::Bank	HBCI_Bank
	This is the C accessible type of a Bank in HBCI.
typedef list< HBCI::Pointer< HBCI::Bank > >	list_HBCI_Bank
	List of HBCI_Bank's.
typedef list< HBCI::Pointer< HBCI::Bank > >::const_iterator	list_HBCI_Bank_iter
	Iterator for List of HBCI_Bank's.
typedef HBCI::instituteMessage	HBCI_instituteMessage
typedef list< HBCI::instituteMessage >	list_HBCI_instituteMessage

---

Detailed Description

HBCI::Bank, its C wrapper HBCI_Bank. Also HBCI::instituteMessage but no C wrappers.

This file contains both the class defition for a C++ application as well as the C wrappers for a C application.

---

Typedef Documentation

typedef struct HBCI::instituteMessage HBCI_instituteMessage

typedef list<HBCI::instituteMessage> list_HBCI_instituteMessage

typedef void*(* list_HBCI_instituteMessage_cb)(HBCI_instituteMessage *msg, void *user_data)

Callback function for list_HBCI_instituteMessage_foreach.

---

Function Documentation

const char* HBCI_instituteMessage_bankCode (  const HBCI_instituteMessage *    m )

Returns the Bank code ("BLZ") of the bank that sent this message (to identify it)

int HBCI_instituteMessage_country (  const HBCI_instituteMessage *    m )

Returns the ISO-3166 country code of the bank that sent this message (to identify it)

const HBCI_Date* HBCI_instituteMessage_date (  const HBCI_instituteMessage *    m )

Returns the Date of arrival.

int HBCI_instituteMessage_read (  const HBCI_instituteMessage *    m )

Helper flag: Returns TRUE if message has been read. However, this is neither set nor reset by OpenHBCI. The state of the flag is stored (FIXME: is this correct), but the application has to manage the flag by itself.

void HBCI_instituteMessage_setRead (  HBCI_instituteMessage *    m, int    b )

Set the flag that shows whether this message has been read. See HBCI_instituteMessage_read().

const char* HBCI_instituteMessage_subject (  const HBCI_instituteMessage *    m )

Returns the subject of this message.

const char* HBCI_instituteMessage_text (  const HBCI_instituteMessage *    m )

Returns the text of the message, just as it was sent by the bank.

const HBCI_Time* HBCI_instituteMessage_time (  const HBCI_instituteMessage *    m )

Returns the Time of arrival.

void* list_HBCI_instituteMessage_foreach (  const list_HBCI_instituteMessage *    list, list_HBCI_instituteMessage_cb    func, void *    user_data )

Traverses the list, calling the callback function 'func' on each list element. Traversal will stop when 'func' returns a non-NULL value, and the routine will return with that value. Otherwise the routine will return NULL. Parameters: list  The list to traverse. func  The function to be called with each list element. user_data  A pointer passed on to the function 'func'. Returns : The non-NULL pointer returned by 'func' as soon as it returns one. Otherwise (i.e. 'func' always returns NULL) returns NULL. Author: Christian Stimming <stimming@tuhh.de>

---