Im- and Exporter Context

Modules
	Securities
	Messages
	Logs

Typedefs
typedef AB_IMEXPORTER_ACCOUNTINFO *()	AB_IMEXPORTER_ACCOUNTINFO_LIST2_FOREACH(AB_IMEXPORTER_ACCOUNTINFO *element, void *user_data)

Functions
AB_IMEXPORTER_CONTEXT *	AB_ImExporterContext_new (void)
void	AB_ImExporterContext_free (AB_IMEXPORTER_CONTEXT *iec)
void	AB_ImExporterContext_Clear (AB_IMEXPORTER_CONTEXT *iec)
int	AB_ImExporterContext_toDb (const AB_IMEXPORTER_CONTEXT *iec, GWEN_DB_NODE *db)
AB_IMEXPORTER_CONTEXT *	AB_ImExporterContext_fromDb (GWEN_DB_NODE *db)
int	AB_ImExporterContext_ReadDb (AB_IMEXPORTER_CONTEXT *iec, GWEN_DB_NODE *db)
void	AB_ImExporterContext_AddContext (AB_IMEXPORTER_CONTEXT *iec, AB_IMEXPORTER_CONTEXT *toAdd)
void	AB_ImExporterContext_AddAccountInfo (AB_IMEXPORTER_CONTEXT *iec, AB_IMEXPORTER_ACCOUNTINFO *iea)
AB_IMEXPORTER_ACCOUNTINFO *	AB_ImExporterContext_GetFirstAccountInfo (AB_IMEXPORTER_CONTEXT *iec)
AB_IMEXPORTER_ACCOUNTINFO *	AB_ImExporterContext_GetNextAccountInfo (AB_IMEXPORTER_CONTEXT *iec)
AB_IMEXPORTER_ACCOUNTINFO *	AB_ImExporterContext_AccountInfoForEach (AB_IMEXPORTER_CONTEXT *iec, AB_IMEXPORTER_ACCOUNTINFO_LIST2_FOREACH func, void *user_data)
AB_IMEXPORTER_ACCOUNTINFO *	AB_ImExporterContext_FindAccountInfo (AB_IMEXPORTER_CONTEXT *iec, const char *bankCode, const char *accountNumber)
AB_IMEXPORTER_ACCOUNTINFO *	AB_ImExporterContext_FindAccountInfoByIban (AB_IMEXPORTER_CONTEXT *iec, const char *iban)
AB_IMEXPORTER_ACCOUNTINFO *	AB_ImExporterContext_GetAccountInfo (AB_IMEXPORTER_CONTEXT *iec, const char *bankCode, const char *accountNumber)
AB_IMEXPORTER_ACCOUNTINFO *	AB_ImExporterContext_GetAccountInfoByIban (AB_IMEXPORTER_CONTEXT *iec, const char *iban)
int	AB_ImExporterContext_GetAccountInfoCount (const AB_IMEXPORTER_CONTEXT *iec)
void	AB_ImExporterContext_AddTransaction (AB_IMEXPORTER_CONTEXT *iec, AB_TRANSACTION *t)
void	AB_ImExporterContext_AddTransfer (AB_IMEXPORTER_CONTEXT *iec, AB_TRANSACTION *t)
void	AB_ImExporterContext_AddStandingOrder (AB_IMEXPORTER_CONTEXT *iec, AB_TRANSACTION *t)
void	AB_ImExporterContext_AddDatedTransfer (AB_IMEXPORTER_CONTEXT *iec, AB_TRANSACTION *t)

Detailed Description

A context contains the list of accounts for which data has been imported or which are to be exported. These accounts each contain a list of imported/to be exported transactions.

Typedef Documentation

AB_IMEXPORTER_ACCOUNTINFO_LIST2_FOREACH

typedef AB_IMEXPORTER_ACCOUNTINFO*() AB_IMEXPORTER_ACCOUNTINFO_LIST2_FOREACH(AB_IMEXPORTER_ACCOUNTINFO *element, void *user_data)

Callback function type for AB_ImExporterContext_AccountInfoForEach()

(As soon as a ACCOUNTINFO_LIST2 is declared in this header, this declaration can be removed.)

Definition at line 285 of file imexporter.h.

Function Documentation

AB_ImExporterContext_AccountInfoForEach()

AB_IMEXPORTER_ACCOUNTINFO* AB_ImExporterContext_AccountInfoForEach	(	AB_IMEXPORTER_CONTEXT *	iec,
		AB_IMEXPORTER_ACCOUNTINFO_LIST2_FOREACH	func,
		void *	user_data
	)

Traverses the list of account infos in this context, 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: Every list element is still owned by the IMEXPORTER_CONTEXT object, so it must neither be free'd nor stored anywhere outside the lifecyle of this AB_IMEXPORTER_CONTEXT.

Available since aqbanking-1.9.7.

Parameters

iec	The importer context.
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.

AB_ImExporterContext_AddAccountInfo()

void AB_ImExporterContext_AddAccountInfo	(	AB_IMEXPORTER_CONTEXT *	iec,
		AB_IMEXPORTER_ACCOUNTINFO *	iea
	)

Takes over ownership of the given account info.

AB_ImExporterContext_AddContext()

void AB_ImExporterContext_AddContext	(	AB_IMEXPORTER_CONTEXT *	iec,
		AB_IMEXPORTER_CONTEXT *	toAdd
	)

Adds the content of the second context to the first one. Frees the second context.

AB_ImExporterContext_AddDatedTransfer()

void AB_ImExporterContext_AddDatedTransfer	(	AB_IMEXPORTER_CONTEXT *	iec,
		AB_TRANSACTION *	t
	)

AB_ImExporterContext_AddStandingOrder()

void AB_ImExporterContext_AddStandingOrder	(	AB_IMEXPORTER_CONTEXT *	iec,
		AB_TRANSACTION *	t
	)

AB_ImExporterContext_AddTransaction()

void AB_ImExporterContext_AddTransaction	(	AB_IMEXPORTER_CONTEXT *	iec,
		AB_TRANSACTION *	t
	)

This is just a convenience function. It takes the bank code and account number from the account, and then calls AB_ImExporterContext_GetAccountInfo and AB_ImExporterAccountInfo_AddTransaction. If you want to add many transactions which are sorted by account it is much faster to avoid this function and to select the appropriate account info object once before importing all transactions for this particular account. This would save you the additional lookup before every transaction.

AB_ImExporterContext_AddTransfer()

void AB_ImExporterContext_AddTransfer	(	AB_IMEXPORTER_CONTEXT *	iec,
		AB_TRANSACTION *	t
	)

This is just a convenience function. It takes the bank code and account number from the account, and then calls AB_ImExporterContext_GetAccountInfo and AB_ImExporterAccountInfo_AddTransfer. If you want to add many transfers which are sorted by account it is much faster to avoid this function and to select the appropriate account info object once before importing all transactions for this particular account. This would save you the additional lookup before every transaction.

AB_ImExporterContext_Clear()

void AB_ImExporterContext_Clear

(

AB_IMEXPORTER_CONTEXT *

iec

)

This function clears the context (e.g. removes all transactions etc). (introduced in AqBanking 4.3.0)

AB_ImExporterContext_FindAccountInfo()

AB_IMEXPORTER_ACCOUNTINFO* AB_ImExporterContext_FindAccountInfo	(	AB_IMEXPORTER_CONTEXT *	iec,
		const char *	bankCode,
		const char *	accountNumber
	)

Looks for account info for the given account. If it is not found 0 is returned. The context remains the owner of the returned object.

AB_ImExporterContext_FindAccountInfoByIban()

AB_IMEXPORTER_ACCOUNTINFO* AB_ImExporterContext_FindAccountInfoByIban	(	AB_IMEXPORTER_CONTEXT *	iec,
		const char *	iban
	)

Looks for account info for the given account. If it is not found 0 is returned. This is for SEPA. The context remains the owner of the returned object.

AB_ImExporterContext_free()

void AB_ImExporterContext_free

(

AB_IMEXPORTER_CONTEXT *

iec

)

AB_ImExporterContext_fromDb()

AB_IMEXPORTER_CONTEXT* AB_ImExporterContext_fromDb

(

GWEN_DB_NODE *

db

)

Restores a complete import/export context from a GWEN_DB.

AB_ImExporterContext_GetAccountInfo()

AB_IMEXPORTER_ACCOUNTINFO* AB_ImExporterContext_GetAccountInfo	(	AB_IMEXPORTER_CONTEXT *	iec,
		const char *	bankCode,
		const char *	accountNumber
	)

Looks for account info for the given account. If there is none it will be created and added to the context. The context remains the owner of the returned object.

AB_ImExporterContext_GetAccountInfoByIban()

AB_IMEXPORTER_ACCOUNTINFO* AB_ImExporterContext_GetAccountInfoByIban	(	AB_IMEXPORTER_CONTEXT *	iec,
		const char *	iban
	)

Looks for account info for the given account. If there is none it will be created and added to the context. This function is for SEPA. The context remains the owner of the returned object.

AB_ImExporterContext_GetAccountInfoCount()

int AB_ImExporterContext_GetAccountInfoCount

(

const AB_IMEXPORTER_CONTEXT *

iec

)

AB_ImExporterContext_GetFirstAccountInfo()

AB_IMEXPORTER_ACCOUNTINFO* AB_ImExporterContext_GetFirstAccountInfo

(

AB_IMEXPORTER_CONTEXT *

iec

)

Returns the first imported account (if any). The context remains the owner of the object returned.

AB_ImExporterContext_GetNextAccountInfo()

AB_IMEXPORTER_ACCOUNTINFO* AB_ImExporterContext_GetNextAccountInfo

(

AB_IMEXPORTER_CONTEXT *

iec

)

Returns the next account data has been imported for. The context remains the owner of the object returned.

AB_ImExporterContext_new()

AB_IMEXPORTER_CONTEXT* AB_ImExporterContext_new

(

void

)

AB_ImExporterContext_ReadDb()

int AB_ImExporterContext_ReadDb	(	AB_IMEXPORTER_CONTEXT *	iec,
		GWEN_DB_NODE *	db
	)

AB_ImExporterContext_toDb()

int AB_ImExporterContext_toDb	(	const AB_IMEXPORTER_CONTEXT *	iec,
		GWEN_DB_NODE *	db
	)

Stores a complete import/export context to a GWEN_DB.