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

HBCI_Transaction functions


List of HBCI_Transaction

typedef void *(* list_HBCI_Transaction_cb )(const HBCI_Transaction *trans, void *user_data)
void list_HBCI_Transaction_delete (list_HBCI_Transaction *l)
void list_HBCI_Transaction_iter_delete (list_HBCI_Transaction_iter *l)
int list_HBCI_Transaction_size (const list_HBCI_Transaction *l)
list_HBCI_Transaction_iter * list_HBCI_Transaction_begin (const list_HBCI_Transaction *l)
list_HBCI_Transaction_iter * list_HBCI_Transaction_end (const list_HBCI_Transaction *l)
const HBCI_Transaction * list_HBCI_Transaction_iter_get (const list_HBCI_Transaction_iter *l)
void list_HBCI_Transaction_iter_next (list_HBCI_Transaction_iter *l)
int list_HBCI_Transaction_iter_equal (const list_HBCI_Transaction_iter *l1, const list_HBCI_Transaction_iter *l2)
void * list_HBCI_Transaction_foreach (const list_HBCI_Transaction *list, list_HBCI_Transaction_cb func, void *user_data)

Our account

int HBCI_Transaction_ourCountryCode (const HBCI_Transaction *t)
void HBCI_Transaction_setOurCountryCode (HBCI_Transaction *t, int i)
const char * HBCI_Transaction_ourBankCode (const HBCI_Transaction *t)
void HBCI_Transaction_setOurBankCode (HBCI_Transaction *t, const char *code)
const char * HBCI_Transaction_ourAccountId (const HBCI_Transaction *t)
void HBCI_Transaction_setOurAccountId (HBCI_Transaction *t, const char *id)
const char * HBCI_Transaction_ourSuffix (const HBCI_Transaction *t)
void HBCI_Transaction_setOurSuffix (HBCI_Transaction *t, const char *id)

Date

const HBCI_Date * HBCI_Transaction_valutaDate (const HBCI_Transaction *t)
void HBCI_Transaction_setValutaDate (HBCI_Transaction *t, const HBCI_Date *d)
const HBCI_Date * HBCI_Transaction_date (const HBCI_Transaction *t)
void HBCI_Transaction_setDate (HBCI_Transaction *t, const HBCI_Date *d)

Value

const HBCI_Value * HBCI_Transaction_value (const HBCI_Transaction *t)
void HBCI_Transaction_setValue (HBCI_Transaction *t, const HBCI_Value *v)

Type of Transaction

const char * HBCI_Transaction_transactionKey (const HBCI_Transaction *t)
void HBCI_Transaction_setTransactionKey (HBCI_Transaction *t, const char *s)

Reference String

const char * HBCI_Transaction_customerReference (const HBCI_Transaction *t)
void HBCI_Transaction_setCustomerReference (HBCI_Transaction *t, const char *s)
const char * HBCI_Transaction_bankReference (const HBCI_Transaction *t)
void HBCI_Transaction_setBankReference (HBCI_Transaction *t, const char *s)

Transaction Description

int HBCI_Transaction_transactionCode (const HBCI_Transaction *t)
void HBCI_Transaction_setTransactionCode (HBCI_Transaction *t, int c)
const char * HBCI_Transaction_transactionText (const HBCI_Transaction *t)
void HBCI_Transaction_setTransactionText (HBCI_Transaction *t, const char *s)
const char * HBCI_Transaction_primanota (const HBCI_Transaction *t)
void HBCI_Transaction_setPrimanota (HBCI_Transaction *t, const char *s)
const list_string * HBCI_Transaction_description (const HBCI_Transaction *t)
void HBCI_Transaction_addDescription (HBCI_Transaction *t, const char *s)

Other account

int HBCI_Transaction_otherCountryCode (const HBCI_Transaction *t)
void HBCI_Transaction_setOtherCountryCode (HBCI_Transaction *t, int i)
const char * HBCI_Transaction_otherBankCode (const HBCI_Transaction *t)
void HBCI_Transaction_setOtherBankCode (HBCI_Transaction *t, const char *s)
const char * HBCI_Transaction_otherAccountId (const HBCI_Transaction *t)
void HBCI_Transaction_setOtherAccountId (HBCI_Transaction *t, const char *s)
const char * HBCI_Transaction_otherSuffix (const HBCI_Transaction *t)
void HBCI_Transaction_setOtherSuffix (HBCI_Transaction *t, const char *id)
const list_string * HBCI_Transaction_otherName (const HBCI_Transaction *t)
void HBCI_Transaction_addOtherName (HBCI_Transaction *t, const char *s)

Typedefs

typedef HBCI::Transaction HBCI_Transaction
 C accessibly type of HBCI::Transaction.

typedef list< HBCI::Transaction > list_HBCI_Transaction
typedef list< HBCI::Transaction
>::const_iterator 		list_HBCI_Transaction_iter

Functions

HBCI_Transaction * HBCI_Transaction_new ()
void HBCI_Transaction_delete (HBCI_Transaction *t)

Typedef Documentation

typedef struct HBCI::Transaction HBCI_Transaction
 

C accessibly type of HBCI::Transaction.

typedef list<HBCI::Transaction> list_HBCI_Transaction
 

typedef void*(* list_HBCI_Transaction_cb)(const HBCI_Transaction *trans, void *user_data)
 

Callback function for list_HBCI_Transaction_foreach .

typedef list<HBCI::Transaction>::const_iterator list_HBCI_Transaction_iter
 

Function Documentation

void HBCI_Transaction_addDescription (  HBCI_Transaction *    t,
const char *    s
) 
 

void HBCI_Transaction_addOtherName (  HBCI_Transaction *    t,
const char *    s
) 
 

const char* HBCI_Transaction_bankReference (  const HBCI_Transaction *    t ) 
 

const char* HBCI_Transaction_customerReference (  const HBCI_Transaction *    t ) 
 

const HBCI_Date* HBCI_Transaction_date (  const HBCI_Transaction *    t ) 
 

The date when the transaction was booked. In MT940 spec this has only four characters (no year), so we take the year from the valutaDate(HBCI_Transaction *t). -- Buchungsdatum in :61:

void HBCI_Transaction_delete (  HBCI_Transaction *    t ) 
 

Destructor

const list_string* HBCI_Transaction_description (  const HBCI_Transaction *    t ) 
 

Description of what this transaction is for, and how the Bank describes this transaction. -- Verwendungszweck; fields 20-29 and 60-63 in field :86:

HBCI_Transaction* HBCI_Transaction_new (    ) 
 

Constructor

const char* HBCI_Transaction_otherAccountId (  const HBCI_Transaction *    t ) 
 

Account number of the other party -- Kontonummer; field 31 in field :86:

const char* HBCI_Transaction_otherBankCode (  const HBCI_Transaction *    t ) 
 

Institute code (BLZ); field 30 in field :86:

int HBCI_Transaction_otherCountryCode (  const HBCI_Transaction *    t ) 
 

Country code (BLZ) of the other party's institute -- not in MT940/field :86:

const list_string* HBCI_Transaction_otherName (  const HBCI_Transaction *    t ) 
 

Name of the other party -- fields 32 and 33 in field :86:

const char* HBCI_Transaction_otherSuffix (  const HBCI_Transaction *    t ) 
 

If the account of the other party has subaccounts which are distinguished by different suffixes, then this is that suffix of the other party. Otherwise it's empty. -- *not* in MT940 / field :86:

const char* HBCI_Transaction_ourAccountId (  const HBCI_Transaction *    t ) 
 

Your account number; up to 23 characters. Note: possibly including the currency (yes, that's what MT940 says) -- Kontonummer in :25:

const char* HBCI_Transaction_ourBankCode (  const HBCI_Transaction *    t ) 
 

bank code of your institute (BLZ or S.W.I.F.T. code) -- BLZ in :25:

The const char* pointer of this and all the following functions points to the c_str() result of the underlying std::string object. It is therefore valid as long as the Transaction object wasn't changed, and it should NOT be free'd by the caller.

int HBCI_Transaction_ourCountryCode (  const HBCI_Transaction *    t ) 
 

country code of your institute -- not in MT940.

const char* HBCI_Transaction_ourSuffix (  const HBCI_Transaction *    t ) 
 

If your account has subaccounts which are distinguished by different suffixes, then this is that suffix. Otherwise it's empty. -- not in MT940

const char* HBCI_Transaction_primanota (  const HBCI_Transaction *    t ) 
 

Primanoten-Number (no idea what this means) -- Primanoten-Nummer; field 10 in field :86:

void HBCI_Transaction_setBankReference (  HBCI_Transaction *    t,
const char *    s
) 
 

void HBCI_Transaction_setCustomerReference (  HBCI_Transaction *    t,
const char *    s
) 
 

void HBCI_Transaction_setDate (  HBCI_Transaction *    t,
const HBCI_Date *    d
) 
 

Parameters:
t  The object to perform this action on.
d  The date. A deep copy of its data will be stored, so the pointer lifecycle doesn't affect this transaction.

void HBCI_Transaction_setOtherAccountId (  HBCI_Transaction *    t,
const char *    s
) 
 

void HBCI_Transaction_setOtherBankCode (  HBCI_Transaction *    t,
const char *    s
) 
 

void HBCI_Transaction_setOtherCountryCode (  HBCI_Transaction *    t,
int    i
) 
 

void HBCI_Transaction_setOtherSuffix (  HBCI_Transaction *    t,
const char *    id
) 
 

void HBCI_Transaction_setOurAccountId (  HBCI_Transaction *    t,
const char *    id
) 
 

void HBCI_Transaction_setOurBankCode (  HBCI_Transaction *    t,
const char *    code
) 
 

void HBCI_Transaction_setOurCountryCode (  HBCI_Transaction *    t,
int    i
) 
 

void HBCI_Transaction_setOurSuffix (  HBCI_Transaction *    t,
const char *    id
) 
 

void HBCI_Transaction_setPrimanota (  HBCI_Transaction *    t,
const char *    s
) 
 

void HBCI_Transaction_setTransactionCode (  HBCI_Transaction *    t,
int    c
) 
 

void HBCI_Transaction_setTransactionKey (  HBCI_Transaction *    t,
const char *    s
) 
 

void HBCI_Transaction_setTransactionText (  HBCI_Transaction *    t,
const char *    s
) 
 

void HBCI_Transaction_setValue (  HBCI_Transaction *    t,
const HBCI_Value *    v
) 
 

Parameters:
t  The object to perform this action on.
v  the value. a deep copy of its data will be stored, so the pointer lifecycle doesn't affect this transaction.

void HBCI_Transaction_setValutaDate (  HBCI_Transaction *    t,
const HBCI_Date *    d
) 
 

Parameters:
t  The object to perform this action on.
d  the date. a deep copy of its data will be stored, so the pointer lifecycle doesn't affect this transaction.

int HBCI_Transaction_transactionCode (  const HBCI_Transaction *    t ) 
 

A 3 digit numerical transaction code, defined for all kinds of different HBCI actions. -- Geschaeftsvorfallcode, first field in field :86:

const char* HBCI_Transaction_transactionKey (  const HBCI_Transaction *    t ) 
 

this is the transaction id that tells you more about the type of transaction (3 character code) -- Buchungsschluessel in :61:

const char* HBCI_Transaction_transactionText (  const HBCI_Transaction *    t ) 
 

HBCI_Transaction text (e.g. STANDING ORDER); field 00 in field :86:

const HBCI_Value* HBCI_Transaction_value (  const HBCI_Transaction *    t ) 
 

The value of this transaction in the account's currency. -- Betrag in :61:

const HBCI_Date* HBCI_Transaction_valutaDate (  const HBCI_Transaction *    t ) 
 

A date "Valuta" when the transaction was (really?) executed -- Datum Valuta/Wertstellung in :61:

list_HBCI_Transaction_iter* list_HBCI_Transaction_begin (  const list_HBCI_Transaction *    l ) 
 

void list_HBCI_Transaction_delete (  list_HBCI_Transaction *    l ) 
 

list_HBCI_Transaction_iter* list_HBCI_Transaction_end (  const list_HBCI_Transaction *    l ) 
 

void* list_HBCI_Transaction_foreach (  const list_HBCI_Transaction *    list,
list_HBCI_Transaction_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_Transaction_iter_delete (  list_HBCI_Transaction_iter *    l ) 
 

int list_HBCI_Transaction_iter_equal (  const list_HBCI_Transaction_iter *    l1,
const list_HBCI_Transaction_iter *    l2
) 
 

const HBCI_Transaction* list_HBCI_Transaction_iter_get (  const list_HBCI_Transaction_iter *    l ) 
 

void list_HBCI_Transaction_iter_next (  list_HBCI_Transaction_iter *    l ) 
 

int list_HBCI_Transaction_size (  const list_HBCI_Transaction *    l ) 
 

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