aqbanking  5.0.24.0-git
Im- and Exporter Account Info
Generic Im- and Exporter

Constructor, Destructor, Copy

AB_IMEXPORTER_ACCOUNTINFOAB_ImExporterAccountInfo_new (void)
void AB_ImExporterAccountInfo_free (AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_FillFromAccount (AB_IMEXPORTER_ACCOUNTINFO *iea, const AB_ACCOUNT *a)
AB_IMEXPORTER_ACCOUNTINFOAB_ImExporterAccountInfo_dup (const AB_IMEXPORTER_ACCOUNTINFO *oldiea)

Informational Functions

const char * AB_ImExporterAccountInfo_GetBankCode (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetBankCode (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)
const char * AB_ImExporterAccountInfo_GetBankName (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetBankName (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)
const char * AB_ImExporterAccountInfo_GetAccountNumber (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetAccountNumber (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)
const char * AB_ImExporterAccountInfo_GetAccountName (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetAccountName (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)
const char * AB_ImExporterAccountInfo_GetIban (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetIban (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)
const char * AB_ImExporterAccountInfo_GetBic (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetBic (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)
const char * AB_ImExporterAccountInfo_GetCurrency (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetCurrency (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)
const char * AB_ImExporterAccountInfo_GetOwner (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetOwner (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)
AB_ACCOUNT_TYPE AB_ImExporterAccountInfo_GetType (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetType (AB_IMEXPORTER_ACCOUNTINFO *iea, AB_ACCOUNT_TYPE t)
const char * AB_ImExporterAccountInfo_GetDescription (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetDescription (AB_IMEXPORTER_ACCOUNTINFO *iea, const char *s)
uint32_t AB_ImExporterAccountInfo_GetAccountId (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_SetAccountId (AB_IMEXPORTER_ACCOUNTINFO *iea, uint32_t id)

Transactions

typedef const AB_TRANSACTION *( AB_TRANSACTION_CONSTLIST2_FOREACH )(const AB_TRANSACTION *element, void *user_data)
void AB_ImExporterAccountInfo_AddTransaction (AB_IMEXPORTER_ACCOUNTINFO *iea, AB_TRANSACTION *t)
AB_TRANSACTIONAB_ImExporterAccountInfo_GetFirstTransaction (AB_IMEXPORTER_ACCOUNTINFO *iea)
AB_TRANSACTIONAB_ImExporterAccountInfo_GetNextTransaction (AB_IMEXPORTER_ACCOUNTINFO *iea)
const AB_TRANSACTIONAB_ImExporterAccountInfo_TransactionsForEach (AB_IMEXPORTER_ACCOUNTINFO *iea, AB_TRANSACTION_CONSTLIST2_FOREACH func, void *user_data)
int AB_ImExporterAccountInfo_GetTransactionCount (const AB_IMEXPORTER_ACCOUNTINFO *iea)
void AB_ImExporterAccountInfo_ClearTransactions (AB_IMEXPORTER_ACCOUNTINFO *iea)

Account Status

void AB_ImExporterAccountInfo_AddAccountStatus (AB_IMEXPORTER_ACCOUNTINFO *iea, AB_ACCOUNT_STATUS *st)
AB_ACCOUNT_STATUSAB_ImExporterAccountInfo_GetFirstAccountStatus (AB_IMEXPORTER_ACCOUNTINFO *iea)
AB_ACCOUNT_STATUSAB_ImExporterAccountInfo_GetNextAccountStatus (AB_IMEXPORTER_ACCOUNTINFO *iea)

Standing Orders

void AB_ImExporterAccountInfo_AddStandingOrder (AB_IMEXPORTER_ACCOUNTINFO *iea, AB_TRANSACTION *t)
AB_TRANSACTIONAB_ImExporterAccountInfo_GetFirstStandingOrder (AB_IMEXPORTER_ACCOUNTINFO *iea)
AB_TRANSACTIONAB_ImExporterAccountInfo_GetNextStandingOrder (AB_IMEXPORTER_ACCOUNTINFO *iea)
int AB_ImExporterAccountInfo_GetStandingOrderCount (const AB_IMEXPORTER_ACCOUNTINFO *iea)

Transfers

void AB_ImExporterAccountInfo_AddTransfer (AB_IMEXPORTER_ACCOUNTINFO *iea, AB_TRANSACTION *t)
AB_TRANSACTIONAB_ImExporterAccountInfo_GetFirstTransfer (AB_IMEXPORTER_ACCOUNTINFO *iea)
AB_TRANSACTIONAB_ImExporterAccountInfo_GetNextTransfer (AB_IMEXPORTER_ACCOUNTINFO *iea)
int AB_ImExporterAccountInfo_GetTransferCount (const AB_IMEXPORTER_ACCOUNTINFO *iea)

Dated Transfers

void AB_ImExporterAccountInfo_AddDatedTransfer (AB_IMEXPORTER_ACCOUNTINFO *iea, AB_TRANSACTION *t)
AB_TRANSACTIONAB_ImExporterAccountInfo_GetFirstDatedTransfer (AB_IMEXPORTER_ACCOUNTINFO *iea)
AB_TRANSACTIONAB_ImExporterAccountInfo_GetNextDatedTransfer (AB_IMEXPORTER_ACCOUNTINFO *iea)
int AB_ImExporterAccountInfo_GetDatedTransferCount (const AB_IMEXPORTER_ACCOUNTINFO *iea)

Noted Transactions

void AB_ImExporterAccountInfo_AddNotedTransaction (AB_IMEXPORTER_ACCOUNTINFO *iea, AB_TRANSACTION *t)
AB_TRANSACTIONAB_ImExporterAccountInfo_GetFirstNotedTransaction (AB_IMEXPORTER_ACCOUNTINFO *iea)
AB_TRANSACTIONAB_ImExporterAccountInfo_GetNextNotedTransaction (AB_IMEXPORTER_ACCOUNTINFO *iea)
int AB_ImExporterAccountInfo_GetNotedTransactionCount (const AB_IMEXPORTER_ACCOUNTINFO *iea)

Detailed Description

Such a structure contains the list of imported/to be exported transactions for a given account.


Typedef Documentation

typedef const AB_TRANSACTION*( AB_TRANSACTION_CONSTLIST2_FOREACH)(const AB_TRANSACTION *element, void *user_data)

Callback function type for AB_ImExporterAccountInfo_TransactionsForEach()

(As soon as transaction.h declares this type itself, this declaration can be removed. Currently transaction.h only declares the LIST2 but not the CONSTLIST2, so we add this declaration here. If transaction.h declares the CONSTLIST2 as well, it wouldn't harm because this typedef is exactly identical to the one from the GWEN_CONSTLIST2_FUNCTION_LIB_DEFS macro.)

Definition at line 639 of file imexporter.h.


Function Documentation

Takes over ownership of the given account status.

Takes over ownership of the given dated transfer.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

Takes over ownership of the given noted transfer.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

Takes over ownership of the given standing order.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

Takes over ownership of the given transaction.

Takes over ownership of the given transfer.

The transfer can be any kind of transfer (like single transfer, debit note, EU transfer etc).

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

Clear all transactions stored in the given account info.

Returns a copy of the given account info. Please note that only the data is copied, internal pointers for AB_ImExporterAccountInfo_GetNextTransaction et al are reset in the copy.

This field is not used by AqBanking but might be used by applications.

Account name. Used when importing data, not used when exporting.

Account number. Used when importing data, not used when exporting.

Bank code of the institute the account is at.

Bank name of the institute the account is at.

BIC.

Account currency

Returns the first account status stored within the context and removes it. The context remains the owner of the object returned.

Returns the first dated transfer stored within the context. The context remains the owner of the object returned.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

Returns the first noted transfer stored within the context. The context remains the owner of the object returned.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

Returns the first standing order stored within the context. The context remains the owner of the object returned.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

Returns the first transaction stored within the context. The context remains the owner of the object returned.

Returns the first transfer stored within the context. The context remains the owner of the object returned. The transfer can be any kind of transfer (like single transfer, debit note, EU transfer etc).

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

IBAN.

Returns the next account status stored within the context and removes it The context remains the owner of the object returned.

Returns the next dated transfer stored within the context. The context remains the owner of the object returned.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

Returns the next noted transfer stored within the context. The context remains the owner of the object returned.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

Returns the next standing order stored within the context. The context remains the owner of the object returned.

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

Returns the next transaction stored within the context. The context remains the owner of the object returned.

Returns the next transfer stored within the context. The context remains the owner of the object returned. The transfer can be any kind of transfer (like single transfer, debit note, EU transfer etc).

This function is only used in the context of the function AB_Banking_GatherResponses. It is especially not used when importing or exporting normal transactions via AB_ImExporter_Import or AB_ImExporter_Export unless explicitly stated otherwise (see documentation of the importer/exporter in question).

Name of the account' owner. Used when importing data, not used when exporting.

void AB_ImExporterAccountInfo_SetBic ( AB_IMEXPORTER_ACCOUNTINFO iea,
const char *  s 
)
void AB_ImExporterAccountInfo_SetIban ( AB_IMEXPORTER_ACCOUNTINFO iea,
const char *  s 
)
void AB_ImExporterAccountInfo_SetOwner ( AB_IMEXPORTER_ACCOUNTINFO iea,
const char *  s 
)

Traverses the list of Transactions in this AccountInfo, 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.

Note: It is not totally clear to me whether this function might interfere with AB_ImExporterAccountInfo_GetFirstTransaction() / AB_ImExporterAccountInfo_GetNextTransaction() . To be on the safe side, you should probably traverse the transaction list only *either* by those mentioned two functions *or* by this ForEach function, but you should probably not mix the access through this two methods. (This doubt be changed in future versions.)

Available since aqbanking-1.9.7.

Parameters:
listThe list to traverse.
funcThe function to be called with each list element.
user_dataA 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.