---

HBCI_Bank functions

These are the functions for the C accessible type of HBCI::Bank. More...

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)
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)
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.

---

Detailed Description

These are the functions for the C accessible type of HBCI::Bank.

---

Typedef Documentation

typedef struct 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 void*(* list_HBCI_Bank_cb)(const HBCI_Bank *bank, void *user_data)

Callback function for list_HBCI_Bank_foreach.

typedef list<HBCI::Pointer<HBCI::Bank> >::const_iterator list_HBCI_Bank_iter

Iterator for List of HBCI_Bank's.

---

Function Documentation

const list_HBCI_Account* HBCI_Bank_accounts (  const HBCI_Bank *    h )

Returns the list of accounts at this bank. Parameters: h  The object to perform this action on.

HBCI_Error* HBCI_Bank_addAccount (  HBCI_Bank *    h, HBCI_Account *    a, int    autoDelete )

Add an account to the account list of this bank. Ideally, you wouldn't need this as the bank is supposed to send you a list of all accounts valid for your user ID. However, some banks simply don't do that, so that's why this method is here. If there already is an entry for the same account a Error will be returned. Parameters: h  The object to perform this action on. a  Account to add. autoDelete  If TRUE, then the HBCI_Bank takes ownership of the HBCI_Account object and will delete it if the life time is over. If FALSE, the HBCI_Bank will not delete the HBCI_Account object; instead, the caller is still responsible for its deletion. Returns : NULL if successful, or pointer to HBCI_Error upon failure.

const char* HBCI_Bank_addr (  const HBCI_Bank *    h )

Returns the communication address. Depends on type of protocol stack: If T-Online, addr is the address of the Gateway as a number. If TCP/IP, addr is the IP address of the HBCI server in dotted notation, e.g. "123.123.123.123". Parameters: h  The object to perform this action on.

HBCI_Error* HBCI_Bank_addUser (  HBCI_Bank *    h, HBCI_User *    c, int    autoDelete )

Adds a customer to the list of customers of this bank. If there already is an entry for this customer a Error will be returned. Parameters: h  The object to perform this action on. c  User to add. autoDelete  If TRUE, then the HBCI_Bank takes ownership of the HBCI_User object and will delete it if the life time is over. If FALSE, the HBCI_Bank will not delete the HBCI_User object; instead, the caller is still responsible for its deletion. Returns : NULL if successful, or pointer to HBCI_Error upon failure.

const char* HBCI_Bank_bankCode (  const HBCI_Bank *    h )

Returns the bank code of this bank. ("Bankleitzahl", BLZ) Parameters: h  The object to perform this action on.

int HBCI_Bank_bpdVersion (  const HBCI_Bank *    h )

Return the version of the "Bank Parameter Daten" (BPD). The BPD contains information about the institute, such as address of the server, country code, bank code etc. If these data change on the server side then the server will increment this number. Upon next dialog initialisation this library checks the versions and receives the new BPD if necessary.

int HBCI_Bank_countryCode (  const HBCI_Bank *    h )

Returns the ISO-3166 countrycode of this bank. In HBCI, "280" is still used for Germany according to the HBCI specs -- even though in the year 1990 the code was changed from 280 to 276 in ISO-3166. Parameters: h  The object to perform this action on.

const HBCI_Account* HBCI_Bank_findAccount (  const HBCI_Bank *    h, const char *    nr )

Searches for an account in the banks internal list. No wildcards or jokers allowed. Parameters: h  The object to perform this action on. nr  account number to match

const HBCI_Account* HBCI_Bank_findAccountWSuf (  const HBCI_Bank *    h, const char *    nr, const char *    suf )

Searches for an account in the banks internal list. This method searches for accounts with account code suffix (new in HBCI 2.2). No wildcards or jokers allowed. Parameters: h  The object to perform this action on. nr  account number to match suf  account suffix

const HBCI_bpdJob* HBCI_Bank_findJob (  const HBCI_Bank *    h, const char *    segname )

Searches for bank parameter data about a HBCI job which matches the given criteria. Parameters: h  The object to perform this action on. segname  The segment name of the HBCI job (e.g. HKSAL...)

const HBCI_bpdJob* HBCI_Bank_findJob_maxv (  const HBCI_Bank *    h, const char *    segname, int    minv, int    maxv )

Searches for bank parameter data about a HBCI job which matches the given criteria. Parameters: h  The object to perform this action on. segname  The segment name of the HBCI job (e.g. HKSAL...) minv  The minimum segment version to look for maxv  The maximum segment version to look for

const HBCI_bpdJob* HBCI_Bank_findJob_minv (  const HBCI_Bank *    h, const char *    segname, int    minv )

Searches for bank parameter data about a HBCI job which matches the given criteria. Parameters: h  The object to perform this action on. segname  The segment name of the HBCI job (e.g. HKSAL...) minv  The minimum segment version to look for

const HBCI_User* HBCI_Bank_findUser (  const HBCI_Bank *    h, const char *    userid )

Searches for a user in the bank's internal list. No wildcards or jokers allowed. Parameters: h  The object to perform this action on. userid  userid to look for

const HBCI_Hbci* HBCI_Bank_hbci (  const HBCI_Bank *    h )

Returns the central HBCI object that controls the user interaction and version control. Parameters: h  The object to perform this action on.

int HBCI_Bank_hbciVersion (  const HBCI_Bank *    h )

Returns the HBCI protocol version used with this bank. This HBCI version number is one out of the list<int> returned by supportedVersions(). This has been set by setHbciVersion, or, if it hasn't been set, it is some default value.

const list_HBCI_instituteMessage* HBCI_Bank_messages (  const HBCI_Bank *    h )

Returns a list of all institute messages that we received from the bank so far. This is a text message like an email. Your bank might send such a message containing usefull information concerning you account. They even might contain advertisements. That only depends on your bank.

const char* HBCI_Bank_name (  const HBCI_Bank *    h )

Returns the name of this Bank. This name is the one that the bank sends back upon initally connecting. Parameters: h  The object to perform this action on.

void HBCI_Bank_setAddr (  HBCI_Bank *    h, const char *    s )

Set the communication address. Depends on type of protocol stack: For TCP/IP, addr is the IP address of the HBCI server in dotted notation, e.g. "123.123.123.123". Parameters: h  The object to perform this action on. s  New communication address.

void HBCI_Bank_setBankCode (  HBCI_Bank *    h, const char *    s )

Set the bank code of this bank. ("Bankleitzahl", BLZ) Parameters: h  The object to perform this action on. s  New bank code string.

void HBCI_Bank_setBPDVersion (  HBCI_Bank *    h, int    i )

Set the version of the "Bank Parameter Daten" (BPD). Set it to "0" if you change the Bank's HBCI-Version because you need the up-to-date-BPD. They are automatically returned if BPD-Version=0 in the Init-Dialog.

void HBCI_Bank_setCountryCode (  HBCI_Bank *    h, int    i )

Set the ISO-3166 countrycode of this bank. (In HBCI: 280 for Germany) Parameters: h  The object to perform this action on. i  New ISO-3166 country code.

void HBCI_Bank_setHbciVersion (  HBCI_Bank *    h, int    v )

Set the HBCI protocol version to be used with this bank.

void HBCI_Bank_setType (  HBCI_Bank *    h, int    i )

Set the type of protocolstack for this bank: 1 == T-Online (ETSI 300 072); 2 == TCP/IP Parameters: h  The object to perform this action on. i  New type of protocolstack.

list_int* HBCI_Bank_supportedVersions (  const HBCI_Bank *    h )

Returns a list of HBCI protocol versions that this bank supports.

int HBCI_Bank_type (  const HBCI_Bank *    h )

Returns the supported type of protocolstack: 1 == T-Online (ETSI 300 072); 2 == TCP/IP Parameters: h  The object to perform this action on.

const list_HBCI_User* HBCI_Bank_users (  const HBCI_Bank *    h )

Returns the list of users of this bank. Parameters: h  The object to perform this action on.

list_HBCI_Bank_iter* list_HBCI_Bank_begin (  const list_HBCI_Bank *    l )

void list_HBCI_Bank_delete (  list_HBCI_Bank *    l )

list_HBCI_Bank_iter* list_HBCI_Bank_end (  const list_HBCI_Bank *    l )

void* list_HBCI_Bank_foreach (  const list_HBCI_Bank *    list, list_HBCI_Bank_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>

void list_HBCI_Bank_iter_delete (  list_HBCI_Bank_iter *    l )

int list_HBCI_Bank_iter_equal (  const list_HBCI_Bank_iter *    l1, const list_HBCI_Bank_iter *    l2 )

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_size (  const list_HBCI_Bank *    l )

---